Completed
Push — add/deprecated-version ( 4b76f2...08d91e )
by
unknown
39:58 queued 31:42
created

Jetpack::xmlrpc_api_url()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 0
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\Config;
5
use Automattic\Jetpack\Connection\Client;
6
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
7
use Automattic\Jetpack\Connection\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 override 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
		}
741
742
		add_action(
743
			'plugins_loaded',
744
			function () {
745
				if ( User_Agent_Info::is_mobile_app() ) {
746
					add_filter( 'get_edit_post_link', '__return_empty_string' );
747
				}
748
			}
749
		);
750
751
		// Update the site's Jetpack plan and products from API on heartbeats.
752
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
753
754
		/**
755
		 * This is the hack to concatenate all css files into one.
756
		 * For description and reasoning see the implode_frontend_css method.
757
		 *
758
		 * Super late priority so we catch all the registered styles.
759
		 */
760
		if ( ! is_admin() ) {
761
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
762
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
763
		}
764
765
		/**
766
		 * These are sync actions that we need to keep track of for jitms
767
		 */
768
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
769
770
		// Actually push the stats on shutdown.
771
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
772
			add_action( 'shutdown', array( $this, 'push_stats' ) );
773
		}
774
775
		// Actions for Manager::authorize().
776
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
777
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
778
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
779
780
		// Filters for the Manager::get_token() urls and request body.
781
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
782
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
783
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
784
785
		// Actions for successful reconnect.
786
		add_action( 'jetpack_reconnection_completed', array( $this, 'reconnection_completed' ) );
787
788
		// Actions for licensing.
789
		Licensing::instance()->initialize();
790
	}
791
792
	/**
793
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
794
	 * Config object.
795
	 */
796
	public function configure() {
797
		$config = new Config();
798
799
		foreach (
800
			array(
801
				'sync',
802
			)
803
			as $feature
804
		) {
805
			$config->ensure( $feature );
806
		}
807
808
		$config->ensure(
809
			'connection',
810
			array(
811
				'slug' => 'jetpack',
812
				'name' => 'Jetpack',
813
			)
814
		);
815
816
		if ( is_admin() ) {
817
			$config->ensure( 'jitm' );
818
		}
819
820
		if ( ! $this->connection_manager ) {
821
			$this->connection_manager = new Connection_Manager( 'jetpack' );
822
		}
823
824
		/*
825
		 * Load things that should only be in Network Admin.
826
		 *
827
		 * For now blow away everything else until a more full
828
		 * understanding of what is needed at the network level is
829
		 * available
830
		 */
831
		if ( is_multisite() ) {
832
			$network = Jetpack_Network::init();
833
			$network->set_connection( $this->connection_manager );
834
		}
835
836
		if ( $this->connection_manager->is_active() ) {
837
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
838
839
			Jetpack_Heartbeat::init();
840
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
841
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
842
				Jetpack_Search_Performance_Logger::init();
843
			}
844
		}
845
846
		// Initialize remote file upload request handlers.
847
		$this->add_remote_request_handlers();
848
849
		/*
850
		 * Enable enhanced handling of previewing sites in Calypso
851
		 */
852
		if ( self::is_active() ) {
853
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
854
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
855
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
856
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
857
		}
858
859
		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...
860
			add_action( 'init', array( new Plugin_Tracking(), 'init' ) );
861
		} else {
862
			/**
863
			 * Initialize tracking right after the user agrees to the terms of service.
864
			 */
865
			add_action( 'jetpack_agreed_to_terms_of_service', array( new Plugin_Tracking(), 'init' ) );
866
		}
867
	}
868
869
	/**
870
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
871
	 * initialization code.
872
	 *
873
	 * @action plugins_loaded
874
	 */
875
	public function late_initialization() {
876
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
877
878
		Partner::init();
879
880
		/**
881
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
882
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
883
		 *
884
		 * @since 8.1.0
885
		 *
886
		 * @param Jetpack $jetpack the main plugin class object.
887
		 */
888
		do_action( 'jetpack_loaded', $this );
889
890
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
891
	}
892
893
	/**
894
	 * Sets up the XMLRPC request handlers.
895
	 *
896
	 * @deprecated since 7.7.0
897
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
898
	 *
899
	 * @param array                 $request_params Incoming request parameters.
900
	 * @param Boolean               $is_active      Whether the connection is currently active.
901
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
902
	 * @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...
903
	 */
904 View Code Duplication
	public function setup_xmlrpc_handlers(
905
		$request_params,
906
		$is_active,
907
		$is_signed,
908
		Jetpack_XMLRPC_Server $xmlrpc_server = null
909
	) {
910
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
911
912
		if ( ! $this->connection_manager ) {
913
			$this->connection_manager = new Connection_Manager();
914
		}
915
916
		return $this->connection_manager->setup_xmlrpc_handlers(
917
			$request_params,
918
			$is_active,
919
			$is_signed,
920
			$xmlrpc_server
921
		);
922
	}
923
924
	/**
925
	 * Initialize REST API registration connector.
926
	 *
927
	 * @deprecated since 7.7.0
928
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
929
	 */
930 View Code Duplication
	public function initialize_rest_api_registration_connector() {
931
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
932
933
		if ( ! $this->connection_manager ) {
934
			$this->connection_manager = new Connection_Manager();
935
		}
936
937
		$this->connection_manager->initialize_rest_api_registration_connector();
938
	}
939
940
	/**
941
	 * This is ported over from the manage module, which has been deprecated and baked in here.
942
	 *
943
	 * @param $domains
944
	 */
945
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
946
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
947
	}
948
949
	/**
950
	 * Return $domains, with 'wordpress.com' appended.
951
	 * This is ported over from the manage module, which has been deprecated and baked in here.
952
	 *
953
	 * @param $domains
954
	 * @return array
955
	 */
956
	function allow_wpcom_domain( $domains ) {
957
		if ( empty( $domains ) ) {
958
			$domains = array();
959
		}
960
		$domains[] = 'wordpress.com';
961
		return array_unique( $domains );
962
	}
963
964
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
965
		$post = get_post( $post_id );
966
967
		if ( empty( $post ) ) {
968
			return $default_url;
969
		}
970
971
		$post_type = $post->post_type;
972
973
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
974
		// https://en.support.wordpress.com/custom-post-types/
975
		$allowed_post_types = array(
976
			'post',
977
			'page',
978
			'jetpack-portfolio',
979
			'jetpack-testimonial',
980
		);
981
982
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
983
			return $default_url;
984
		}
985
986
		return Redirect::get_url(
987
			'calypso-edit-' . $post_type,
988
			array(
989
				'path' => $post_id,
990
			)
991
		);
992
	}
993
994
	function point_edit_comment_links_to_calypso( $url ) {
995
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
996
		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...
997
998
		return Redirect::get_url(
999
			'calypso-edit-comment',
1000
			array(
1001
				'path' => $query_args['amp;c'],
1002
			)
1003
		);
1004
1005
	}
1006
1007
	function jetpack_track_last_sync_callback( $params ) {
1008
		/**
1009
		 * Filter to turn off jitm caching
1010
		 *
1011
		 * @since 5.4.0
1012
		 *
1013
		 * @param bool false Whether to cache just in time messages
1014
		 */
1015
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
1016
			return $params;
1017
		}
1018
1019
		if ( is_array( $params ) && isset( $params[0] ) ) {
1020
			$option = $params[0];
1021
			if ( 'active_plugins' === $option ) {
1022
				// use the cache if we can, but not terribly important if it gets evicted
1023
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
1024
			}
1025
		}
1026
1027
		return $params;
1028
	}
1029
1030
	function jetpack_connection_banner_callback() {
1031
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
1032
1033
		// Disable the banner dismiss functionality if the pre-connection prompt helpers filter is set.
1034
		if (
1035
			isset( $_REQUEST['dismissBanner'] ) &&
1036
			! Jetpack_Connection_Banner::force_display()
1037
		) {
1038
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
1039
			wp_send_json_success();
1040
		}
1041
1042
		wp_die();
1043
	}
1044
1045
	/**
1046
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1047
	 * Only used in our alternate XML-RPC endpoint, where we want to
1048
	 * ensure that Core and other plugins' methods are not exposed.
1049
	 *
1050
	 * @deprecated since 7.7.0
1051
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1052
	 *
1053
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1054
	 * @return array Filtered $methods
1055
	 */
1056 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1057
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1058
1059
		if ( ! $this->connection_manager ) {
1060
			$this->connection_manager = new Connection_Manager();
1061
		}
1062
1063
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1064
	}
1065
1066
	/**
1067
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1068
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1069
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1070
	 * which is accessible via a different URI. Most of the below is copied directly
1071
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1072
	 *
1073
	 * @deprecated since 7.7.0
1074
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1075
	 */
1076 View Code Duplication
	public function alternate_xmlrpc() {
1077
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1078
1079
		if ( ! $this->connection_manager ) {
1080
			$this->connection_manager = new Connection_Manager();
1081
		}
1082
1083
		$this->connection_manager->alternate_xmlrpc();
1084
	}
1085
1086
	/**
1087
	 * The callback for the JITM ajax requests.
1088
	 *
1089
	 * @deprecated since 7.9.0
1090
	 */
1091
	function jetpack_jitm_ajax_callback() {
1092
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1093
	}
1094
1095
	/**
1096
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1097
	 */
1098
	function push_stats() {
1099
		if ( ! empty( $this->stats ) ) {
1100
			$this->do_stats( 'server_side' );
1101
		}
1102
	}
1103
1104
	/**
1105
	 * Sets the Jetpack custom capabilities.
1106
	 *
1107
	 * @param string[] $caps    Array of the user's capabilities.
1108
	 * @param string   $cap     Capability name.
1109
	 * @param int      $user_id The user ID.
1110
	 * @param array    $args    Adds the context to the cap. Typically the object ID.
1111
	 */
1112
	public function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1113
		$is_offline_mode = ( new Status() )->is_offline_mode();
1114
		switch ( $cap ) {
1115
			case 'jetpack_manage_modules':
1116
			case 'jetpack_activate_modules':
1117
			case 'jetpack_deactivate_modules':
1118
				$caps = array( 'manage_options' );
1119
				break;
1120
			case 'jetpack_configure_modules':
1121
				$caps = array( 'manage_options' );
1122
				break;
1123
			case 'jetpack_manage_autoupdates':
1124
				$caps = array(
1125
					'manage_options',
1126
					'update_plugins',
1127
				);
1128
				break;
1129
			case 'jetpack_network_admin_page':
1130
			case 'jetpack_network_settings_page':
1131
				$caps = array( 'manage_network_plugins' );
1132
				break;
1133
			case 'jetpack_network_sites_page':
1134
				$caps = array( 'manage_sites' );
1135
				break;
1136
			case 'jetpack_admin_page':
1137
				if ( $is_offline_mode ) {
1138
					$caps = array( 'manage_options' );
1139
					break;
1140
				} else {
1141
					$caps = array( 'read' );
1142
				}
1143
				break;
1144
		}
1145
		return $caps;
1146
	}
1147
1148
	/**
1149
	 * Require a Jetpack authentication.
1150
	 *
1151
	 * @deprecated since 7.7.0
1152
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1153
	 */
1154 View Code Duplication
	public function require_jetpack_authentication() {
1155
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1156
1157
		if ( ! $this->connection_manager ) {
1158
			$this->connection_manager = new Connection_Manager();
1159
		}
1160
1161
		$this->connection_manager->require_jetpack_authentication();
1162
	}
1163
1164
	/**
1165
	 * Register assets for use in various modules and the Jetpack admin page.
1166
	 *
1167
	 * @uses wp_script_is, wp_register_script, plugins_url
1168
	 * @action wp_loaded
1169
	 * @return null
1170
	 */
1171
	public function register_assets() {
1172 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1173
			wp_register_script(
1174
				'jetpack-gallery-settings',
1175
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1176
				array( 'media-views' ),
1177
				'20121225'
1178
			);
1179
		}
1180
1181
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1182
			wp_register_script(
1183
				'jetpack-twitter-timeline',
1184
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1185
				array( 'jquery' ),
1186
				'4.0.0',
1187
				true
1188
			);
1189
		}
1190
1191
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1192
			wp_register_script(
1193
				'jetpack-facebook-embed',
1194
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1195
				array(),
1196
				null,
1197
				true
1198
			);
1199
1200
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1201
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1202
			if ( ! is_numeric( $fb_app_id ) ) {
1203
				$fb_app_id = '';
1204
			}
1205
			wp_localize_script(
1206
				'jetpack-facebook-embed',
1207
				'jpfbembed',
1208
				array(
1209
					'appid'  => $fb_app_id,
1210
					'locale' => $this->get_locale(),
1211
				)
1212
			);
1213
		}
1214
1215
		/**
1216
		 * As jetpack_register_genericons is by default fired off a hook,
1217
		 * the hook may have already fired by this point.
1218
		 * So, let's just trigger it manually.
1219
		 */
1220
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1221
		jetpack_register_genericons();
1222
1223
		/**
1224
		 * Register the social logos
1225
		 */
1226
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1227
		jetpack_register_social_logos();
1228
1229 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1230
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1231
		}
1232
	}
1233
1234
	/**
1235
	 * Guess locale from language code.
1236
	 *
1237
	 * @param string $lang Language code.
1238
	 * @return string|bool
1239
	 */
1240 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1241
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1242
			return 'en_US';
1243
		}
1244
1245
		if ( ! class_exists( 'GP_Locales' ) ) {
1246
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1247
				return false;
1248
			}
1249
1250
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1251
		}
1252
1253
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1254
			// WP.com: get_locale() returns 'it'
1255
			$locale = GP_Locales::by_slug( $lang );
1256
		} else {
1257
			// Jetpack: get_locale() returns 'it_IT';
1258
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1259
		}
1260
1261
		if ( ! $locale ) {
1262
			return false;
1263
		}
1264
1265
		if ( empty( $locale->facebook_locale ) ) {
1266
			if ( empty( $locale->wp_locale ) ) {
1267
				return false;
1268
			} else {
1269
				// Facebook SDK is smart enough to fall back to en_US if a
1270
				// locale isn't supported. Since supported Facebook locales
1271
				// can fall out of sync, we'll attempt to use the known
1272
				// wp_locale value and rely on said fallback.
1273
				return $locale->wp_locale;
1274
			}
1275
		}
1276
1277
		return $locale->facebook_locale;
1278
	}
1279
1280
	/**
1281
	 * Get the locale.
1282
	 *
1283
	 * @return string|bool
1284
	 */
1285
	function get_locale() {
1286
		$locale = $this->guess_locale_from_lang( get_locale() );
1287
1288
		if ( ! $locale ) {
1289
			$locale = 'en_US';
1290
		}
1291
1292
		return $locale;
1293
	}
1294
1295
	/**
1296
	 * Return the network_site_url so that .com knows what network this site is a part of.
1297
	 *
1298
	 * @param  bool $option
1299
	 * @return string
1300
	 */
1301
	public function jetpack_main_network_site_option( $option ) {
1302
		return network_site_url();
1303
	}
1304
	/**
1305
	 * Network Name.
1306
	 */
1307
	static function network_name( $option = null ) {
1308
		global $current_site;
1309
		return $current_site->site_name;
1310
	}
1311
	/**
1312
	 * Does the network allow new user and site registrations.
1313
	 *
1314
	 * @return string
1315
	 */
1316
	static function network_allow_new_registrations( $option = null ) {
1317
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1318
	}
1319
	/**
1320
	 * Does the network allow admins to add new users.
1321
	 *
1322
	 * @return boolian
1323
	 */
1324
	static function network_add_new_users( $option = null ) {
1325
		return (bool) get_site_option( 'add_new_users' );
1326
	}
1327
	/**
1328
	 * File upload psace left per site in MB.
1329
	 *  -1 means NO LIMIT.
1330
	 *
1331
	 * @return number
1332
	 */
1333
	static function network_site_upload_space( $option = null ) {
1334
		// value in MB
1335
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1336
	}
1337
1338
	/**
1339
	 * Network allowed file types.
1340
	 *
1341
	 * @return string
1342
	 */
1343
	static function network_upload_file_types( $option = null ) {
1344
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1345
	}
1346
1347
	/**
1348
	 * Maximum file upload size set by the network.
1349
	 *
1350
	 * @return number
1351
	 */
1352
	static function network_max_upload_file_size( $option = null ) {
1353
		// value in KB
1354
		return get_site_option( 'fileupload_maxk', 300 );
1355
	}
1356
1357
	/**
1358
	 * Lets us know if a site allows admins to manage the network.
1359
	 *
1360
	 * @return array
1361
	 */
1362
	static function network_enable_administration_menus( $option = null ) {
1363
		return get_site_option( 'menu_items' );
1364
	}
1365
1366
	/**
1367
	 * If a user has been promoted to or demoted from admin, we need to clear the
1368
	 * jetpack_other_linked_admins transient.
1369
	 *
1370
	 * @since 4.3.2
1371
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1372
	 *
1373
	 * @param int    $user_id   The user ID whose role changed.
1374
	 * @param string $role      The new role.
1375
	 * @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...
1376
	 */
1377
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1378
		if ( 'administrator' == $role
1379
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1380
			|| is_null( $old_roles )
1381
		) {
1382
			delete_transient( 'jetpack_other_linked_admins' );
1383
		}
1384
	}
1385
1386
	/**
1387
	 * Checks to see if there are any other users available to become primary
1388
	 * Users must both:
1389
	 * - Be linked to wpcom
1390
	 * - Be an admin
1391
	 *
1392
	 * @return mixed False if no other users are linked, Int if there are.
1393
	 */
1394
	static function get_other_linked_admins() {
1395
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1396
1397
		if ( false === $other_linked_users ) {
1398
			$admins = get_users( array( 'role' => 'administrator' ) );
1399
			if ( count( $admins ) > 1 ) {
1400
				$available = array();
1401
				foreach ( $admins as $admin ) {
1402
					if ( self::is_user_connected( $admin->ID ) ) {
1403
						$available[] = $admin->ID;
1404
					}
1405
				}
1406
1407
				$count_connected_admins = count( $available );
1408
				if ( count( $available ) > 1 ) {
1409
					$other_linked_users = $count_connected_admins;
1410
				} else {
1411
					$other_linked_users = 0;
1412
				}
1413
			} else {
1414
				$other_linked_users = 0;
1415
			}
1416
1417
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1418
		}
1419
1420
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1421
	}
1422
1423
	/**
1424
	 * Return whether we are dealing with a multi network setup or not.
1425
	 * The reason we are type casting this is because we want to avoid the situation where
1426
	 * the result is false since when is_main_network_option return false it cases
1427
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1428
	 * database which could be set to anything as opposed to what this function returns.
1429
	 *
1430
	 * @param  bool $option
1431
	 *
1432
	 * @return boolean
1433
	 */
1434
	public function is_main_network_option( $option ) {
1435
		// return '1' or ''
1436
		return (string) (bool) self::is_multi_network();
1437
	}
1438
1439
	/**
1440
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1441
	 *
1442
	 * @param  string $option
1443
	 * @return boolean
1444
	 */
1445
	public function is_multisite( $option ) {
1446
		return (string) (bool) is_multisite();
1447
	}
1448
1449
	/**
1450
	 * Implemented since there is no core is multi network function
1451
	 * Right now there is no way to tell if we which network is the dominant network on the system
1452
	 *
1453
	 * @since  3.3
1454
	 * @return boolean
1455
	 */
1456 View Code Duplication
	public static function is_multi_network() {
1457
		global  $wpdb;
1458
1459
		// if we don't have a multi site setup no need to do any more
1460
		if ( ! is_multisite() ) {
1461
			return false;
1462
		}
1463
1464
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1465
		if ( $num_sites > 1 ) {
1466
			return true;
1467
		} else {
1468
			return false;
1469
		}
1470
	}
1471
1472
	/**
1473
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1474
	 *
1475
	 * @return null
1476
	 */
1477
	function update_jetpack_main_network_site_option() {
1478
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1479
	}
1480
	/**
1481
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1482
	 */
1483
	function update_jetpack_network_settings() {
1484
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1485
		// Only sync this info for the main network site.
1486
	}
1487
1488
	/**
1489
	 * Get back if the current site is single user site.
1490
	 *
1491
	 * @return bool
1492
	 */
1493 View Code Duplication
	public static function is_single_user_site() {
1494
		global $wpdb;
1495
1496
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1497
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1498
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1499
		}
1500
		return 1 === (int) $some_users;
1501
	}
1502
1503
	/**
1504
	 * Returns true if the site has file write access false otherwise.
1505
	 *
1506
	 * @return string ( '1' | '0' )
1507
	 **/
1508
	public static function file_system_write_access() {
1509
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1510
			require_once ABSPATH . 'wp-admin/includes/file.php';
1511
		}
1512
1513
		require_once ABSPATH . 'wp-admin/includes/template.php';
1514
1515
		$filesystem_method = get_filesystem_method();
1516
		if ( $filesystem_method === 'direct' ) {
1517
			return 1;
1518
		}
1519
1520
		ob_start();
1521
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1522
		ob_end_clean();
1523
		if ( $filesystem_credentials_are_stored ) {
1524
			return 1;
1525
		}
1526
		return 0;
1527
	}
1528
1529
	/**
1530
	 * Finds out if a site is using a version control system.
1531
	 *
1532
	 * @return string ( '1' | '0' )
1533
	 **/
1534
	public static function is_version_controlled() {
1535
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1536
		return (string) (int) Functions::is_version_controlled();
1537
	}
1538
1539
	/**
1540
	 * Determines whether the current theme supports featured images or not.
1541
	 *
1542
	 * @return string ( '1' | '0' )
1543
	 */
1544
	public static function featured_images_enabled() {
1545
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1546
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1547
	}
1548
1549
	/**
1550
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1551
	 *
1552
	 * @deprecated 4.7 use get_avatar_url instead.
1553
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1554
	 * @param int               $size Size of the avatar image
1555
	 * @param string            $default URL to a default image to use if no avatar is available
1556
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1557
	 *
1558
	 * @return array
1559
	 */
1560
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1561
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1562
		return get_avatar_url(
1563
			$id_or_email,
1564
			array(
1565
				'size'          => $size,
1566
				'default'       => $default,
1567
				'force_default' => $force_display,
1568
			)
1569
		);
1570
	}
1571
// phpcs:disable WordPress.WP.CapitalPDangit.Misspelled
1572
	/**
1573
	 * jetpack_updates is saved in the following schema:
1574
	 *
1575
	 * array (
1576
	 *      'plugins'                       => (int) Number of plugin updates available.
1577
	 *      'themes'                        => (int) Number of theme updates available.
1578
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1579
	 *      'translations'                  => (int) Number of translation updates available.
1580
	 *      'total'                         => (int) Total of all available updates.
1581
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1582
	 * )
1583
	 *
1584
	 * @return array
1585
	 */
1586
	public static function get_updates() {
1587
		$update_data = wp_get_update_data();
1588
1589
		// Stores the individual update counts as well as the total count.
1590
		if ( isset( $update_data['counts'] ) ) {
1591
			$updates = $update_data['counts'];
1592
		}
1593
1594
		// If we need to update WordPress core, let's find the latest version number.
1595 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1596
			$cur = get_preferred_from_update_core();
1597
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1598
				$updates['wp_update_version'] = $cur->current;
1599
			}
1600
		}
1601
		return isset( $updates ) ? $updates : array();
1602
	}
1603
	// phpcs:enable
1604
1605
	public static function get_update_details() {
1606
		$update_details = array(
1607
			'update_core'    => get_site_transient( 'update_core' ),
1608
			'update_plugins' => get_site_transient( 'update_plugins' ),
1609
			'update_themes'  => get_site_transient( 'update_themes' ),
1610
		);
1611
		return $update_details;
1612
	}
1613
1614
	public static function refresh_update_data() {
1615
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1616
1617
	}
1618
1619
	public static function refresh_theme_data() {
1620
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1621
	}
1622
1623
	/**
1624
	 * Is Jetpack active?
1625
	 * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1626
	 *
1627
	 * @return bool
1628
	 */
1629
	public static function is_active() {
1630
		return self::connection()->is_active();
1631
	}
1632
1633
	/**
1634
	 * Make an API call to WordPress.com for plan status
1635
	 *
1636
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1637
	 *
1638
	 * @return bool True if plan is updated, false if no update
1639
	 */
1640
	public static function refresh_active_plan_from_wpcom() {
1641
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1642
		return Jetpack_Plan::refresh_from_wpcom();
1643
	}
1644
1645
	/**
1646
	 * Get the plan that this Jetpack site is currently using
1647
	 *
1648
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1649
	 * @return array Active Jetpack plan details.
1650
	 */
1651
	public static function get_active_plan() {
1652
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1653
		return Jetpack_Plan::get();
1654
	}
1655
1656
	/**
1657
	 * Determine whether the active plan supports a particular feature
1658
	 *
1659
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1660
	 * @return bool True if plan supports feature, false if not.
1661
	 */
1662
	public static function active_plan_supports( $feature ) {
1663
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1664
		return Jetpack_Plan::supports( $feature );
1665
	}
1666
1667
	/**
1668
	 * Deprecated: Is Jetpack in development (offline) mode?
1669
	 *
1670
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1671
	 * and themes still use it, and we do not want to flood them with notices.
1672
	 *
1673
	 * Please use Automattic\Jetpack\Status()->is_offline_mode() instead.
1674
	 *
1675
	 * @deprecated since 8.0.
1676
	 */
1677
	public static function is_development_mode() {
1678
		return ( new Status() )->is_offline_mode();
1679
	}
1680
1681
	/**
1682
	 * Whether the site is currently onboarding or not.
1683
	 * A site is considered as being onboarded if it currently has an onboarding token.
1684
	 *
1685
	 * @since 5.8
1686
	 *
1687
	 * @access public
1688
	 * @static
1689
	 *
1690
	 * @return bool True if the site is currently onboarding, false otherwise
1691
	 */
1692
	public static function is_onboarding() {
1693
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1694
	}
1695
1696
	/**
1697
	 * Determines reason for Jetpack offline mode.
1698
	 */
1699
	public static function development_mode_trigger_text() {
1700
		$status = new Status();
1701
1702
		if ( ! $status->is_offline_mode() ) {
1703
			return __( 'Jetpack is not in Offline Mode.', 'jetpack' );
1704
		}
1705
1706
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1707
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1708
		} elseif ( defined( 'WP_LOCAL_DEV' ) && WP_LOCAL_DEV ) {
1709
			$notice = __( 'The WP_LOCAL_DEV constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1710
		} elseif ( $status->is_local_site() ) {
1711
			$notice = __( 'The site URL is a known local development environment URL (e.g. http://localhost).', 'jetpack' );
1712
			/** This filter is documented in packages/status/src/class-status.php */
1713
		} elseif ( has_filter( 'jetpack_development_mode' ) && apply_filters( 'jetpack_development_mode', false ) ) { // This is a deprecated filter name.
1714
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1715
		} else {
1716
			$notice = __( 'The jetpack_offline_mode filter is set to true.', 'jetpack' );
1717
		}
1718
1719
		return $notice;
1720
1721
	}
1722
	/**
1723
	 * Get Jetpack offline mode notice text and notice class.
1724
	 *
1725
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_offline_mode
1726
	 */
1727
	public static function show_development_mode_notice() {
1728 View Code Duplication
		if ( ( new Status() )->is_offline_mode() ) {
1729
			$notice = sprintf(
1730
				/* translators: %s is a URL */
1731
				__( 'In <a href="%s" target="_blank">Offline Mode</a>:', 'jetpack' ),
1732
				Redirect::get_url( 'jetpack-support-development-mode' )
1733
			);
1734
1735
			$notice .= ' ' . self::development_mode_trigger_text();
1736
1737
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1738
		}
1739
1740
		// Throw up a notice if using a development version and as for feedback.
1741
		if ( self::is_development_version() ) {
1742
			/* translators: %s is a URL */
1743
			$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' ) );
1744
1745
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1746
		}
1747
		// Throw up a notice if using staging mode
1748 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1749
			/* translators: %s is a URL */
1750
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1751
1752
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1753
		}
1754
	}
1755
1756
	/**
1757
	 * Whether Jetpack's version maps to a public release, or a development version.
1758
	 */
1759
	public static function is_development_version() {
1760
		/**
1761
		 * Allows filtering whether this is a development version of Jetpack.
1762
		 *
1763
		 * This filter is especially useful for tests.
1764
		 *
1765
		 * @since 4.3.0
1766
		 *
1767
		 * @param bool $development_version Is this a develoment version of Jetpack?
1768
		 */
1769
		return (bool) apply_filters(
1770
			'jetpack_development_version',
1771
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1772
		);
1773
	}
1774
1775
	/**
1776
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1777
	 */
1778
	public static function is_user_connected( $user_id = false ) {
1779
		return self::connection()->is_user_connected( $user_id );
1780
	}
1781
1782
	/**
1783
	 * Get the wpcom user data of the current|specified connected user.
1784
	 */
1785 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1786
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1787
		if ( ! $user_id ) {
1788
			$user_id = get_current_user_id();
1789
		}
1790
1791
		$transient_key = "jetpack_connected_user_data_$user_id";
1792
1793
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1794
			return $cached_user_data;
1795
		}
1796
1797
		$xml = new Jetpack_IXR_Client(
1798
			array(
1799
				'user_id' => $user_id,
1800
			)
1801
		);
1802
		$xml->query( 'wpcom.getUser' );
1803
		if ( ! $xml->isError() ) {
1804
			$user_data = $xml->getResponse();
1805
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1806
			return $user_data;
1807
		}
1808
1809
		return false;
1810
	}
1811
1812
	/**
1813
	 * Get the wpcom email of the current|specified connected user.
1814
	 */
1815
	public static function get_connected_user_email( $user_id = null ) {
1816
		if ( ! $user_id ) {
1817
			$user_id = get_current_user_id();
1818
		}
1819
1820
		$xml = new Jetpack_IXR_Client(
1821
			array(
1822
				'user_id' => $user_id,
1823
			)
1824
		);
1825
		$xml->query( 'wpcom.getUserEmail' );
1826
		if ( ! $xml->isError() ) {
1827
			return $xml->getResponse();
1828
		}
1829
		return false;
1830
	}
1831
1832
	/**
1833
	 * Get the wpcom email of the master user.
1834
	 */
1835
	public static function get_master_user_email() {
1836
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1837
		if ( $master_user_id ) {
1838
			return self::get_connected_user_email( $master_user_id );
1839
		}
1840
		return '';
1841
	}
1842
1843
	/**
1844
	 * Whether the current user is the connection owner.
1845
	 *
1846
	 * @deprecated since 7.7
1847
	 *
1848
	 * @return bool Whether the current user is the connection owner.
1849
	 */
1850
	public function current_user_is_connection_owner() {
1851
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1852
		return self::connection()->is_connection_owner();
1853
	}
1854
1855
	/**
1856
	 * Gets current user IP address.
1857
	 *
1858
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1859
	 *
1860
	 * @return string                  Current user IP address.
1861
	 */
1862
	public static function current_user_ip( $check_all_headers = false ) {
1863
		if ( $check_all_headers ) {
1864
			foreach ( array(
1865
				'HTTP_CF_CONNECTING_IP',
1866
				'HTTP_CLIENT_IP',
1867
				'HTTP_X_FORWARDED_FOR',
1868
				'HTTP_X_FORWARDED',
1869
				'HTTP_X_CLUSTER_CLIENT_IP',
1870
				'HTTP_FORWARDED_FOR',
1871
				'HTTP_FORWARDED',
1872
				'HTTP_VIA',
1873
			) as $key ) {
1874
				if ( ! empty( $_SERVER[ $key ] ) ) {
1875
					return $_SERVER[ $key ];
1876
				}
1877
			}
1878
		}
1879
1880
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1881
	}
1882
1883
	/**
1884
	 * Synchronize connected user role changes
1885
	 */
1886
	function user_role_change( $user_id ) {
1887
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1888
		Users::user_role_change( $user_id );
1889
	}
1890
1891
	/**
1892
	 * Loads the currently active modules.
1893
	 */
1894
	public static function load_modules() {
1895
		$is_offline_mode = ( new Status() )->is_offline_mode();
1896
		if (
1897
			! self::is_active()
1898
			&& ! $is_offline_mode
1899
			&& ! self::is_onboarding()
1900
			&& (
1901
				! is_multisite()
1902
				|| ! get_site_option( 'jetpack_protect_active' )
1903
			)
1904
		) {
1905
			return;
1906
		}
1907
1908
		$version = Jetpack_Options::get_option( 'version' );
1909 View Code Duplication
		if ( ! $version ) {
1910
			$version = $old_version = JETPACK__VERSION . ':' . time();
1911
			/** This action is documented in class.jetpack.php */
1912
			do_action( 'updating_jetpack_version', $version, false );
1913
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1914
		}
1915
		list( $version ) = explode( ':', $version );
1916
1917
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1918
1919
		$modules_data = array();
1920
1921
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1922
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1923
			$updated_modules = array();
1924
			foreach ( $modules as $module ) {
1925
				$modules_data[ $module ] = self::get_module( $module );
1926
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1927
					continue;
1928
				}
1929
1930
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1931
					continue;
1932
				}
1933
1934
				$updated_modules[] = $module;
1935
			}
1936
1937
			$modules = array_diff( $modules, $updated_modules );
1938
		}
1939
1940
		foreach ( $modules as $index => $module ) {
1941
			// If we're in offline mode, disable modules requiring a connection.
1942
			if ( $is_offline_mode ) {
1943
				// Prime the pump if we need to
1944
				if ( empty( $modules_data[ $module ] ) ) {
1945
					$modules_data[ $module ] = self::get_module( $module );
1946
				}
1947
				// If the module requires a connection, but we're in local mode, don't include it.
1948
				if ( $modules_data[ $module ]['requires_connection'] ) {
1949
					continue;
1950
				}
1951
			}
1952
1953
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1954
				continue;
1955
			}
1956
1957
			if ( ! include_once self::get_module_path( $module ) ) {
1958
				unset( $modules[ $index ] );
1959
				self::update_active_modules( array_values( $modules ) );
1960
				continue;
1961
			}
1962
1963
			/**
1964
			 * Fires when a specific module is loaded.
1965
			 * The dynamic part of the hook, $module, is the module slug.
1966
			 *
1967
			 * @since 1.1.0
1968
			 */
1969
			do_action( 'jetpack_module_loaded_' . $module );
1970
		}
1971
1972
		/**
1973
		 * Fires when all the modules are loaded.
1974
		 *
1975
		 * @since 1.1.0
1976
		 */
1977
		do_action( 'jetpack_modules_loaded' );
1978
1979
		// 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.
1980
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1981
	}
1982
1983
	/**
1984
	 * Check if Jetpack's REST API compat file should be included
1985
	 *
1986
	 * @action plugins_loaded
1987
	 * @return null
1988
	 */
1989
	public function check_rest_api_compat() {
1990
		/**
1991
		 * Filters the list of REST API compat files to be included.
1992
		 *
1993
		 * @since 2.2.5
1994
		 *
1995
		 * @param array $args Array of REST API compat files to include.
1996
		 */
1997
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1998
1999
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
2000
			require_once $_jetpack_rest_api_compat_include;
2001
		}
2002
	}
2003
2004
	/**
2005
	 * Gets all plugins currently active in values, regardless of whether they're
2006
	 * traditionally activated or network activated.
2007
	 *
2008
	 * @todo Store the result in core's object cache maybe?
2009
	 */
2010
	public static function get_active_plugins() {
2011
		$active_plugins = (array) get_option( 'active_plugins', array() );
2012
2013
		if ( is_multisite() ) {
2014
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2015
			// whereas active_plugins stores them in the values.
2016
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2017
			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...
2018
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2019
			}
2020
		}
2021
2022
		sort( $active_plugins );
2023
2024
		return array_unique( $active_plugins );
2025
	}
2026
2027
	/**
2028
	 * Gets and parses additional plugin data to send with the heartbeat data
2029
	 *
2030
	 * @since 3.8.1
2031
	 *
2032
	 * @return array Array of plugin data
2033
	 */
2034
	public static function get_parsed_plugin_data() {
2035
		if ( ! function_exists( 'get_plugins' ) ) {
2036
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2037
		}
2038
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2039
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2040
		$active_plugins = self::get_active_plugins();
2041
2042
		$plugins = array();
2043
		foreach ( $all_plugins as $path => $plugin_data ) {
2044
			$plugins[ $path ] = array(
2045
				'is_active' => in_array( $path, $active_plugins ),
2046
				'file'      => $path,
2047
				'name'      => $plugin_data['Name'],
2048
				'version'   => $plugin_data['Version'],
2049
				'author'    => $plugin_data['Author'],
2050
			);
2051
		}
2052
2053
		return $plugins;
2054
	}
2055
2056
	/**
2057
	 * Gets and parses theme data to send with the heartbeat data
2058
	 *
2059
	 * @since 3.8.1
2060
	 *
2061
	 * @return array Array of theme data
2062
	 */
2063
	public static function get_parsed_theme_data() {
2064
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2065
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2066
2067
		$themes = array();
2068
		foreach ( $all_themes as $slug => $theme_data ) {
2069
			$theme_headers = array();
2070
			foreach ( $header_keys as $header_key ) {
2071
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2072
			}
2073
2074
			$themes[ $slug ] = array(
2075
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2076
				'slug'            => $slug,
2077
				'theme_root'      => $theme_data->get_theme_root_uri(),
2078
				'parent'          => $theme_data->parent(),
2079
				'headers'         => $theme_headers,
2080
			);
2081
		}
2082
2083
		return $themes;
2084
	}
2085
2086
	/**
2087
	 * Checks whether a specific plugin is active.
2088
	 *
2089
	 * We don't want to store these in a static variable, in case
2090
	 * there are switch_to_blog() calls involved.
2091
	 */
2092
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2093
		return in_array( $plugin, self::get_active_plugins() );
2094
	}
2095
2096
	/**
2097
	 * Check if Jetpack's Open Graph tags should be used.
2098
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2099
	 *
2100
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2101
	 * @action plugins_loaded
2102
	 * @return null
2103
	 */
2104
	public function check_open_graph() {
2105
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2106
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2107
		}
2108
2109
		$active_plugins = self::get_active_plugins();
2110
2111
		if ( ! empty( $active_plugins ) ) {
2112
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2113
				if ( in_array( $plugin, $active_plugins ) ) {
2114
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2115
					break;
2116
				}
2117
			}
2118
		}
2119
2120
		/**
2121
		 * Allow the addition of Open Graph Meta Tags to all pages.
2122
		 *
2123
		 * @since 2.0.3
2124
		 *
2125
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2126
		 */
2127
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2128
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2129
		}
2130
	}
2131
2132
	/**
2133
	 * Check if Jetpack's Twitter tags should be used.
2134
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2135
	 *
2136
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2137
	 * @action plugins_loaded
2138
	 * @return null
2139
	 */
2140
	public function check_twitter_tags() {
2141
2142
		$active_plugins = self::get_active_plugins();
2143
2144
		if ( ! empty( $active_plugins ) ) {
2145
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2146
				if ( in_array( $plugin, $active_plugins ) ) {
2147
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2148
					break;
2149
				}
2150
			}
2151
		}
2152
2153
		/**
2154
		 * Allow Twitter Card Meta tags to be disabled.
2155
		 *
2156
		 * @since 2.6.0
2157
		 *
2158
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2159
		 */
2160
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2161
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2162
		}
2163
	}
2164
2165
	/**
2166
	 * Allows plugins to submit security reports.
2167
	 *
2168
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2169
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2170
	 * @param array  $args         See definitions above
2171
	 */
2172
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2173
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2174
	}
2175
2176
	/* Jetpack Options API */
2177
2178
	public static function get_option_names( $type = 'compact' ) {
2179
		return Jetpack_Options::get_option_names( $type );
2180
	}
2181
2182
	/**
2183
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2184
	 *
2185
	 * @param string $name    Option name
2186
	 * @param mixed  $default (optional)
2187
	 */
2188
	public static function get_option( $name, $default = false ) {
2189
		return Jetpack_Options::get_option( $name, $default );
2190
	}
2191
2192
	/**
2193
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2194
	 *
2195
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2196
	 * @param string $name  Option name
2197
	 * @param mixed  $value Option value
2198
	 */
2199
	public static function update_option( $name, $value ) {
2200
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2201
		return Jetpack_Options::update_option( $name, $value );
2202
	}
2203
2204
	/**
2205
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2206
	 *
2207
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2208
	 * @param array $array array( option name => option value, ... )
2209
	 */
2210
	public static function update_options( $array ) {
2211
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2212
		return Jetpack_Options::update_options( $array );
2213
	}
2214
2215
	/**
2216
	 * Deletes the given option.  May be passed multiple option names as an array.
2217
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2218
	 *
2219
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2220
	 * @param string|array $names
2221
	 */
2222
	public static function delete_option( $names ) {
2223
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2224
		return Jetpack_Options::delete_option( $names );
2225
	}
2226
2227
	/**
2228
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2229
	 *
2230
	 * Enters a user token into the user_tokens option
2231
	 *
2232
	 * @param int    $user_id The user id.
2233
	 * @param string $token The user token.
2234
	 * @param bool   $is_master_user Whether the user is the master user.
2235
	 * @return bool
2236
	 */
2237
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2238
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2239
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2240
	}
2241
2242
	/**
2243
	 * Returns an array of all PHP files in the specified absolute path.
2244
	 * Equivalent to glob( "$absolute_path/*.php" ).
2245
	 *
2246
	 * @param string $absolute_path The absolute path of the directory to search.
2247
	 * @return array Array of absolute paths to the PHP files.
2248
	 */
2249
	public static function glob_php( $absolute_path ) {
2250
		if ( function_exists( 'glob' ) ) {
2251
			return glob( "$absolute_path/*.php" );
2252
		}
2253
2254
		$absolute_path = untrailingslashit( $absolute_path );
2255
		$files         = array();
2256
		if ( ! $dir = @opendir( $absolute_path ) ) {
2257
			return $files;
2258
		}
2259
2260
		while ( false !== $file = readdir( $dir ) ) {
2261
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2262
				continue;
2263
			}
2264
2265
			$file = "$absolute_path/$file";
2266
2267
			if ( ! is_file( $file ) ) {
2268
				continue;
2269
			}
2270
2271
			$files[] = $file;
2272
		}
2273
2274
		closedir( $dir );
2275
2276
		return $files;
2277
	}
2278
2279
	public static function activate_new_modules( $redirect = false ) {
2280
		if ( ! self::is_active() && ! ( new Status() )->is_offline_mode() ) {
2281
			return;
2282
		}
2283
2284
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2285 View Code Duplication
		if ( ! $jetpack_old_version ) {
2286
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2287
			/** This action is documented in class.jetpack.php */
2288
			do_action( 'updating_jetpack_version', $version, false );
2289
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2290
		}
2291
2292
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2293
2294
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2295
			return;
2296
		}
2297
2298
		$active_modules     = self::get_active_modules();
2299
		$reactivate_modules = array();
2300
		foreach ( $active_modules as $active_module ) {
2301
			$module = self::get_module( $active_module );
2302
			if ( ! isset( $module['changed'] ) ) {
2303
				continue;
2304
			}
2305
2306
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2307
				continue;
2308
			}
2309
2310
			$reactivate_modules[] = $active_module;
2311
			self::deactivate_module( $active_module );
2312
		}
2313
2314
		$new_version = JETPACK__VERSION . ':' . time();
2315
		/** This action is documented in class.jetpack.php */
2316
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2317
		Jetpack_Options::update_options(
2318
			array(
2319
				'version'     => $new_version,
2320
				'old_version' => $jetpack_old_version,
2321
			)
2322
		);
2323
2324
		self::state( 'message', 'modules_activated' );
2325
2326
		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...
2327
2328
		if ( $redirect ) {
2329
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2330
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2331
				$page = $_GET['page'];
2332
			}
2333
2334
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2335
			exit;
2336
		}
2337
	}
2338
2339
	/**
2340
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2341
	 * Make sure to tuck away module "library" files in a sub-directory.
2342
	 */
2343
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2344
		static $modules = null;
2345
2346
		if ( ! isset( $modules ) ) {
2347
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2348
			// Use the cache if we're on the front-end and it's available...
2349
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2350
				$modules = $available_modules_option[ JETPACK__VERSION ];
2351
			} else {
2352
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2353
2354
				$modules = array();
2355
2356
				foreach ( $files as $file ) {
2357
					if ( ! $headers = self::get_module( $file ) ) {
2358
						continue;
2359
					}
2360
2361
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2362
				}
2363
2364
				Jetpack_Options::update_option(
2365
					'available_modules',
2366
					array(
2367
						JETPACK__VERSION => $modules,
2368
					)
2369
				);
2370
			}
2371
		}
2372
2373
		/**
2374
		 * Filters the array of modules available to be activated.
2375
		 *
2376
		 * @since 2.4.0
2377
		 *
2378
		 * @param array $modules Array of available modules.
2379
		 * @param string $min_version Minimum version number required to use modules.
2380
		 * @param string $max_version Maximum version number required to use modules.
2381
		 */
2382
		$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...
2383
2384
		if ( ! $min_version && ! $max_version ) {
2385
			return array_keys( $mods );
2386
		}
2387
2388
		$r = array();
2389
		foreach ( $mods as $slug => $introduced ) {
2390
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2391
				continue;
2392
			}
2393
2394
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2395
				continue;
2396
			}
2397
2398
			$r[] = $slug;
2399
		}
2400
2401
		return $r;
2402
	}
2403
2404
	/**
2405
	 * Default modules loaded on activation.
2406
	 */
2407
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2408
		$return = array();
2409
2410
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2411
			$module_data = self::get_module( $module );
2412
2413
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2414
				case 'yes':
2415
					$return[] = $module;
2416
					break;
2417
				case 'public':
2418
					if ( Jetpack_Options::get_option( 'public' ) ) {
2419
						$return[] = $module;
2420
					}
2421
					break;
2422
				case 'no':
2423
				default:
2424
					break;
2425
			}
2426
		}
2427
		/**
2428
		 * Filters the array of default modules.
2429
		 *
2430
		 * @since 2.5.0
2431
		 *
2432
		 * @param array $return Array of default modules.
2433
		 * @param string $min_version Minimum version number required to use modules.
2434
		 * @param string $max_version Maximum version number required to use modules.
2435
		 */
2436
		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...
2437
	}
2438
2439
	/**
2440
	 * Checks activated modules during auto-activation to determine
2441
	 * if any of those modules are being deprecated.  If so, close
2442
	 * them out, and add any replacement modules.
2443
	 *
2444
	 * Runs at priority 99 by default.
2445
	 *
2446
	 * This is run late, so that it can still activate a module if
2447
	 * the new module is a replacement for another that the user
2448
	 * currently has active, even if something at the normal priority
2449
	 * would kibosh everything.
2450
	 *
2451
	 * @since 2.6
2452
	 * @uses jetpack_get_default_modules filter
2453
	 * @param array $modules
2454
	 * @return array
2455
	 */
2456
	function handle_deprecated_modules( $modules ) {
2457
		$deprecated_modules = array(
2458
			'debug'            => null,  // Closed out and moved to the debugger library.
2459
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2460
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2461
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2462
		);
2463
2464
		// Don't activate SSO if they never completed activating WPCC.
2465
		if ( self::is_module_active( 'wpcc' ) ) {
2466
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2467
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2468
				$deprecated_modules['wpcc'] = null;
2469
			}
2470
		}
2471
2472
		foreach ( $deprecated_modules as $module => $replacement ) {
2473
			if ( self::is_module_active( $module ) ) {
2474
				self::deactivate_module( $module );
2475
				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...
2476
					$modules[] = $replacement;
2477
				}
2478
			}
2479
		}
2480
2481
		return array_unique( $modules );
2482
	}
2483
2484
	/**
2485
	 * Checks activated plugins during auto-activation to determine
2486
	 * if any of those plugins are in the list with a corresponding module
2487
	 * that is not compatible with the plugin. The module will not be allowed
2488
	 * to auto-activate.
2489
	 *
2490
	 * @since 2.6
2491
	 * @uses jetpack_get_default_modules filter
2492
	 * @param array $modules
2493
	 * @return array
2494
	 */
2495
	function filter_default_modules( $modules ) {
2496
2497
		$active_plugins = self::get_active_plugins();
2498
2499
		if ( ! empty( $active_plugins ) ) {
2500
2501
			// For each module we'd like to auto-activate...
2502
			foreach ( $modules as $key => $module ) {
2503
				// If there are potential conflicts for it...
2504
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2505
					// For each potential conflict...
2506
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2507
						// If that conflicting plugin is active...
2508
						if ( in_array( $plugin, $active_plugins ) ) {
2509
							// Remove that item from being auto-activated.
2510
							unset( $modules[ $key ] );
2511
						}
2512
					}
2513
				}
2514
			}
2515
		}
2516
2517
		return $modules;
2518
	}
2519
2520
	/**
2521
	 * Extract a module's slug from its full path.
2522
	 */
2523
	public static function get_module_slug( $file ) {
2524
		return str_replace( '.php', '', basename( $file ) );
2525
	}
2526
2527
	/**
2528
	 * Generate a module's path from its slug.
2529
	 */
2530
	public static function get_module_path( $slug ) {
2531
		/**
2532
		 * Filters the path of a modules.
2533
		 *
2534
		 * @since 7.4.0
2535
		 *
2536
		 * @param array $return The absolute path to a module's root php file
2537
		 * @param string $slug The module slug
2538
		 */
2539
		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...
2540
	}
2541
2542
	/**
2543
	 * Load module data from module file. Headers differ from WordPress
2544
	 * plugin headers to avoid them being identified as standalone
2545
	 * plugins on the WordPress plugins page.
2546
	 */
2547
	public static function get_module( $module ) {
2548
		$headers = array(
2549
			'name'                      => 'Module Name',
2550
			'description'               => 'Module Description',
2551
			'sort'                      => 'Sort Order',
2552
			'recommendation_order'      => 'Recommendation Order',
2553
			'introduced'                => 'First Introduced',
2554
			'changed'                   => 'Major Changes In',
2555
			'deactivate'                => 'Deactivate',
2556
			'free'                      => 'Free',
2557
			'requires_connection'       => 'Requires Connection',
2558
			'auto_activate'             => 'Auto Activate',
2559
			'module_tags'               => 'Module Tags',
2560
			'feature'                   => 'Feature',
2561
			'additional_search_queries' => 'Additional Search Queries',
2562
			'plan_classes'              => 'Plans',
2563
		);
2564
2565
		$file = self::get_module_path( self::get_module_slug( $module ) );
2566
2567
		$mod = self::get_file_data( $file, $headers );
2568
		if ( empty( $mod['name'] ) ) {
2569
			return false;
2570
		}
2571
2572
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2573
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2574
		$mod['deactivate']           = empty( $mod['deactivate'] );
2575
		$mod['free']                 = empty( $mod['free'] );
2576
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2577
2578
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2579
			$mod['auto_activate'] = 'No';
2580
		} else {
2581
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2582
		}
2583
2584
		if ( $mod['module_tags'] ) {
2585
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2586
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2587
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2588
		} else {
2589
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2590
		}
2591
2592 View Code Duplication
		if ( $mod['plan_classes'] ) {
2593
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2594
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2595
		} else {
2596
			$mod['plan_classes'] = array( 'free' );
2597
		}
2598
2599 View Code Duplication
		if ( $mod['feature'] ) {
2600
			$mod['feature'] = explode( ',', $mod['feature'] );
2601
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2602
		} else {
2603
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2604
		}
2605
2606
		/**
2607
		 * Filters the feature array on a module.
2608
		 *
2609
		 * This filter allows you to control where each module is filtered: Recommended,
2610
		 * and the default "Other" listing.
2611
		 *
2612
		 * @since 3.5.0
2613
		 *
2614
		 * @param array   $mod['feature'] The areas to feature this module:
2615
		 *     'Recommended' shows on the main Jetpack admin screen.
2616
		 *     'Other' should be the default if no other value is in the array.
2617
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2618
		 * @param array   $mod All the currently assembled module data.
2619
		 */
2620
		$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...
2621
2622
		/**
2623
		 * Filter the returned data about a module.
2624
		 *
2625
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2626
		 * so please be careful.
2627
		 *
2628
		 * @since 3.6.0
2629
		 *
2630
		 * @param array   $mod    The details of the requested module.
2631
		 * @param string  $module The slug of the module, e.g. sharedaddy
2632
		 * @param string  $file   The path to the module source file.
2633
		 */
2634
		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...
2635
	}
2636
2637
	/**
2638
	 * Like core's get_file_data implementation, but caches the result.
2639
	 */
2640
	public static function get_file_data( $file, $headers ) {
2641
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2642
		$file_name = basename( $file );
2643
2644
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2645
2646
		$file_data_option = get_transient( $cache_key );
2647
2648
		if ( ! is_array( $file_data_option ) ) {
2649
			delete_transient( $cache_key );
2650
			$file_data_option = false;
2651
		}
2652
2653
		if ( false === $file_data_option ) {
2654
			$file_data_option = array();
2655
		}
2656
2657
		$key           = md5( $file_name . serialize( $headers ) );
2658
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2659
2660
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2661
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2662
			return $file_data_option[ $key ];
2663
		}
2664
2665
		$data = get_file_data( $file, $headers );
2666
2667
		$file_data_option[ $key ] = $data;
2668
2669
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2670
2671
		return $data;
2672
	}
2673
2674
	/**
2675
	 * Return translated module tag.
2676
	 *
2677
	 * @param string $tag Tag as it appears in each module heading.
2678
	 *
2679
	 * @return mixed
2680
	 */
2681
	public static function translate_module_tag( $tag ) {
2682
		return jetpack_get_module_i18n_tag( $tag );
2683
	}
2684
2685
	/**
2686
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2687
	 *
2688
	 * @since 3.9.2
2689
	 *
2690
	 * @param array $modules
2691
	 *
2692
	 * @return string|void
2693
	 */
2694
	public static function get_translated_modules( $modules ) {
2695
		foreach ( $modules as $index => $module ) {
2696
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2697
			if ( isset( $module['name'] ) ) {
2698
				$modules[ $index ]['name'] = $i18n_module['name'];
2699
			}
2700
			if ( isset( $module['description'] ) ) {
2701
				$modules[ $index ]['description']       = $i18n_module['description'];
2702
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2703
			}
2704
		}
2705
		return $modules;
2706
	}
2707
2708
	/**
2709
	 * Get a list of activated modules as an array of module slugs.
2710
	 */
2711
	public static function get_active_modules() {
2712
		$active = Jetpack_Options::get_option( 'active_modules' );
2713
2714
		if ( ! is_array( $active ) ) {
2715
			$active = array();
2716
		}
2717
2718
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2719
			$active[] = 'vaultpress';
2720
		} else {
2721
			$active = array_diff( $active, array( 'vaultpress' ) );
2722
		}
2723
2724
		// If protect is active on the main site of a multisite, it should be active on all sites.
2725
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2726
			$active[] = 'protect';
2727
		}
2728
2729
		/**
2730
		 * Allow filtering of the active modules.
2731
		 *
2732
		 * Gives theme and plugin developers the power to alter the modules that
2733
		 * are activated on the fly.
2734
		 *
2735
		 * @since 5.8.0
2736
		 *
2737
		 * @param array $active Array of active module slugs.
2738
		 */
2739
		$active = apply_filters( 'jetpack_active_modules', $active );
2740
2741
		return array_unique( $active );
2742
	}
2743
2744
	/**
2745
	 * Check whether or not a Jetpack module is active.
2746
	 *
2747
	 * @param string $module The slug of a Jetpack module.
2748
	 * @return bool
2749
	 *
2750
	 * @static
2751
	 */
2752
	public static function is_module_active( $module ) {
2753
		return in_array( $module, self::get_active_modules() );
2754
	}
2755
2756
	public static function is_module( $module ) {
2757
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2758
	}
2759
2760
	/**
2761
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2762
	 *
2763
	 * @param bool $catch True to start catching, False to stop.
2764
	 *
2765
	 * @static
2766
	 */
2767
	public static function catch_errors( $catch ) {
2768
		static $display_errors, $error_reporting;
2769
2770
		if ( $catch ) {
2771
			$display_errors  = @ini_set( 'display_errors', 1 );
2772
			$error_reporting = @error_reporting( E_ALL );
2773
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2774
		} else {
2775
			@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...
2776
			@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...
2777
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2778
		}
2779
	}
2780
2781
	/**
2782
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2783
	 */
2784
	public static function catch_errors_on_shutdown() {
2785
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2786
	}
2787
2788
	/**
2789
	 * Rewrite any string to make paths easier to read.
2790
	 *
2791
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2792
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2793
	 *
2794
	 * @param $string
2795
	 * @return mixed
2796
	 */
2797
	public static function alias_directories( $string ) {
2798
		// ABSPATH has a trailing slash.
2799
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2800
		// WP_CONTENT_DIR does not have a trailing slash.
2801
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2802
2803
		return $string;
2804
	}
2805
2806
	public static function activate_default_modules(
2807
		$min_version = false,
2808
		$max_version = false,
2809
		$other_modules = array(),
2810
		$redirect = null,
2811
		$send_state_messages = null
2812
	) {
2813
		$jetpack = self::init();
2814
2815
		if ( is_null( $redirect ) ) {
2816
			if (
2817
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2818
			||
2819
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2820
			||
2821
				( defined( 'WP_CLI' ) && WP_CLI )
2822
			||
2823
				( defined( 'DOING_CRON' ) && DOING_CRON )
2824
			||
2825
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2826
			) {
2827
				$redirect = false;
2828
			} elseif ( is_admin() ) {
2829
				$redirect = true;
2830
			} else {
2831
				$redirect = false;
2832
			}
2833
		}
2834
2835
		if ( is_null( $send_state_messages ) ) {
2836
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2837
		}
2838
2839
		$modules = self::get_default_modules( $min_version, $max_version );
2840
		$modules = array_merge( $other_modules, $modules );
2841
2842
		// Look for standalone plugins and disable if active.
2843
2844
		$to_deactivate = array();
2845
		foreach ( $modules as $module ) {
2846
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2847
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2848
			}
2849
		}
2850
2851
		$deactivated = array();
2852
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2853
			list( $probable_file, $probable_title ) = $deactivate_me;
2854
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2855
				$deactivated[] = $module;
2856
			}
2857
		}
2858
2859
		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...
2860
			if ( $send_state_messages ) {
2861
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2862
			}
2863
2864
			if ( $redirect ) {
2865
				$url = add_query_arg(
2866
					array(
2867
						'action'   => 'activate_default_modules',
2868
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2869
					),
2870
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2871
				);
2872
				wp_safe_redirect( $url );
2873
				exit;
2874
			}
2875
		}
2876
2877
		/**
2878
		 * Fires before default modules are activated.
2879
		 *
2880
		 * @since 1.9.0
2881
		 *
2882
		 * @param string $min_version Minimum version number required to use modules.
2883
		 * @param string $max_version Maximum version number required to use modules.
2884
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2885
		 */
2886
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2887
2888
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2889
		if ( $send_state_messages ) {
2890
			self::restate();
2891
			self::catch_errors( true );
2892
		}
2893
2894
		$active = self::get_active_modules();
2895
2896
		foreach ( $modules as $module ) {
2897
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2898
				$active[] = $module;
2899
				self::update_active_modules( $active );
2900
				continue;
2901
			}
2902
2903
			if ( $send_state_messages && in_array( $module, $active ) ) {
2904
				$module_info = self::get_module( $module );
2905 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2906
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2907
					if ( $active_state = self::state( $state ) ) {
2908
						$active_state = explode( ',', $active_state );
2909
					} else {
2910
						$active_state = array();
2911
					}
2912
					$active_state[] = $module;
2913
					self::state( $state, implode( ',', $active_state ) );
2914
				}
2915
				continue;
2916
			}
2917
2918
			$file = self::get_module_path( $module );
2919
			if ( ! file_exists( $file ) ) {
2920
				continue;
2921
			}
2922
2923
			// we'll override this later if the plugin can be included without fatal error
2924
			if ( $redirect ) {
2925
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2926
			}
2927
2928
			if ( $send_state_messages ) {
2929
				self::state( 'error', 'module_activation_failed' );
2930
				self::state( 'module', $module );
2931
			}
2932
2933
			ob_start();
2934
			require_once $file;
2935
2936
			$active[] = $module;
2937
2938 View Code Duplication
			if ( $send_state_messages ) {
2939
2940
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2941
				if ( $active_state = self::state( $state ) ) {
2942
					$active_state = explode( ',', $active_state );
2943
				} else {
2944
					$active_state = array();
2945
				}
2946
				$active_state[] = $module;
2947
				self::state( $state, implode( ',', $active_state ) );
2948
			}
2949
2950
			self::update_active_modules( $active );
2951
2952
			ob_end_clean();
2953
		}
2954
2955
		if ( $send_state_messages ) {
2956
			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...
2957
			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...
2958
		}
2959
2960
		self::catch_errors( false );
2961
		/**
2962
		 * Fires when default modules are activated.
2963
		 *
2964
		 * @since 1.9.0
2965
		 *
2966
		 * @param string $min_version Minimum version number required to use modules.
2967
		 * @param string $max_version Maximum version number required to use modules.
2968
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2969
		 */
2970
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2971
	}
2972
2973
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2974
		/**
2975
		 * Fires before a module is activated.
2976
		 *
2977
		 * @since 2.6.0
2978
		 *
2979
		 * @param string $module Module slug.
2980
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2981
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2982
		 */
2983
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2984
2985
		$jetpack = self::init();
2986
2987
		if ( ! strlen( $module ) ) {
2988
			return false;
2989
		}
2990
2991
		if ( ! self::is_module( $module ) ) {
2992
			return false;
2993
		}
2994
2995
		// If it's already active, then don't do it again
2996
		$active = self::get_active_modules();
2997
		foreach ( $active as $act ) {
2998
			if ( $act == $module ) {
2999
				return true;
3000
			}
3001
		}
3002
3003
		$module_data = self::get_module( $module );
3004
3005
		$is_offline_mode = ( new Status() )->is_offline_mode();
3006
		if ( ! self::is_active() ) {
3007
			if ( ! $is_offline_mode && ! self::is_onboarding() ) {
3008
				return false;
3009
			}
3010
3011
			// If we're not connected but in offline mode, make sure the module doesn't require a connection.
3012
			if ( $is_offline_mode && $module_data['requires_connection'] ) {
3013
				return false;
3014
			}
3015
		}
3016
3017
		// Check and see if the old plugin is active
3018
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3019
			// Deactivate the old plugin
3020
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3021
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3022
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3023
				self::state( 'deactivated_plugins', $module );
3024
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3025
				exit;
3026
			}
3027
		}
3028
3029
		// Protect won't work with mis-configured IPs
3030
		if ( 'protect' === $module ) {
3031
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3032
			if ( ! jetpack_protect_get_ip() ) {
3033
				self::state( 'message', 'protect_misconfigured_ip' );
3034
				return false;
3035
			}
3036
		}
3037
3038
		if ( ! Jetpack_Plan::supports( $module ) ) {
3039
			return false;
3040
		}
3041
3042
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3043
		self::state( 'module', $module );
3044
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3045
3046
		self::catch_errors( true );
3047
		ob_start();
3048
		require self::get_module_path( $module );
3049
		/** This action is documented in class.jetpack.php */
3050
		do_action( 'jetpack_activate_module', $module );
3051
		$active[] = $module;
3052
		self::update_active_modules( $active );
3053
3054
		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...
3055
		ob_end_clean();
3056
		self::catch_errors( false );
3057
3058
		if ( $redirect ) {
3059
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3060
		}
3061
		if ( $exit ) {
3062
			exit;
3063
		}
3064
		return true;
3065
	}
3066
3067
	function activate_module_actions( $module ) {
3068
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3069
	}
3070
3071
	public static function deactivate_module( $module ) {
3072
		/**
3073
		 * Fires when a module is deactivated.
3074
		 *
3075
		 * @since 1.9.0
3076
		 *
3077
		 * @param string $module Module slug.
3078
		 */
3079
		do_action( 'jetpack_pre_deactivate_module', $module );
3080
3081
		$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...
3082
3083
		$active = self::get_active_modules();
3084
		$new    = array_filter( array_diff( $active, (array) $module ) );
3085
3086
		return self::update_active_modules( $new );
3087
	}
3088
3089
	public static function enable_module_configurable( $module ) {
3090
		$module = self::get_module_slug( $module );
3091
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3092
	}
3093
3094
	/**
3095
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3096
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3097
	 *
3098
	 * @param string $module Module slug
3099
	 * @return string $url module configuration URL
3100
	 */
3101
	public static function module_configuration_url( $module ) {
3102
		$module      = self::get_module_slug( $module );
3103
		$default_url = self::admin_url() . "#/settings?term=$module";
3104
		/**
3105
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3106
		 *
3107
		 * @since 6.9.0
3108
		 *
3109
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3110
		 */
3111
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3112
3113
		return $url;
3114
	}
3115
3116
	/* Installation */
3117
	public static function bail_on_activation( $message, $deactivate = true ) {
3118
		?>
3119
<!doctype html>
3120
<html>
3121
<head>
3122
<meta charset="<?php bloginfo( 'charset' ); ?>">
3123
<style>
3124
* {
3125
	text-align: center;
3126
	margin: 0;
3127
	padding: 0;
3128
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3129
}
3130
p {
3131
	margin-top: 1em;
3132
	font-size: 18px;
3133
}
3134
</style>
3135
<body>
3136
<p><?php echo esc_html( $message ); ?></p>
3137
</body>
3138
</html>
3139
		<?php
3140
		if ( $deactivate ) {
3141
			$plugins = get_option( 'active_plugins' );
3142
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3143
			$update  = false;
3144
			foreach ( $plugins as $i => $plugin ) {
3145
				if ( $plugin === $jetpack ) {
3146
					$plugins[ $i ] = false;
3147
					$update        = true;
3148
				}
3149
			}
3150
3151
			if ( $update ) {
3152
				update_option( 'active_plugins', array_filter( $plugins ) );
3153
			}
3154
		}
3155
		exit;
3156
	}
3157
3158
	/**
3159
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3160
	 *
3161
	 * @static
3162
	 */
3163
	public static function plugin_activation( $network_wide ) {
3164
		Jetpack_Options::update_option( 'activated', 1 );
3165
3166
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3167
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3168
		}
3169
3170
		if ( $network_wide ) {
3171
			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...
3172
		}
3173
3174
		// For firing one-off events (notices) immediately after activation
3175
		set_transient( 'activated_jetpack', true, 0.1 * MINUTE_IN_SECONDS );
3176
3177
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3178
3179
		Health::on_jetpack_activated();
3180
3181
		self::plugin_initialize();
3182
	}
3183
3184
	public static function get_activation_source( $referer_url ) {
3185
3186
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3187
			return array( 'wp-cli', null );
3188
		}
3189
3190
		$referer = wp_parse_url( $referer_url );
3191
3192
		$source_type  = 'unknown';
3193
		$source_query = null;
3194
3195
		if ( ! is_array( $referer ) ) {
3196
			return array( $source_type, $source_query );
3197
		}
3198
3199
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3200
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3201
3202
		if ( isset( $referer['query'] ) ) {
3203
			parse_str( $referer['query'], $query_parts );
3204
		} else {
3205
			$query_parts = array();
3206
		}
3207
3208
		if ( $plugins_path === $referer['path'] ) {
3209
			$source_type = 'list';
3210
		} elseif ( $plugins_install_path === $referer['path'] ) {
3211
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3212
			switch ( $tab ) {
3213
				case 'popular':
3214
					$source_type = 'popular';
3215
					break;
3216
				case 'recommended':
3217
					$source_type = 'recommended';
3218
					break;
3219
				case 'favorites':
3220
					$source_type = 'favorites';
3221
					break;
3222
				case 'search':
3223
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3224
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3225
					break;
3226
				default:
3227
					$source_type = 'featured';
3228
			}
3229
		}
3230
3231
		return array( $source_type, $source_query );
3232
	}
3233
3234
	/**
3235
	 * Runs before bumping version numbers up to a new version
3236
	 *
3237
	 * @param string $version    Version:timestamp.
3238
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3239
	 */
3240
	public static function do_version_bump( $version, $old_version ) {
3241
		if ( $old_version ) { // For existing Jetpack installations.
3242
3243
			// If a front end page is visited after the update, the 'wp' action will fire.
3244
			add_action( 'wp', 'Jetpack::set_update_modal_display' );
3245
3246
			// If an admin page is visited after the update, the 'current_screen' action will fire.
3247
			add_action( 'current_screen', 'Jetpack::set_update_modal_display' );
3248
		}
3249
	}
3250
3251
	/**
3252
	 * Sets the display_update_modal state.
3253
	 */
3254
	public static function set_update_modal_display() {
3255
		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...
3256
	}
3257
3258
	/**
3259
	 * Sets the internal version number and activation state.
3260
	 *
3261
	 * @static
3262
	 */
3263
	public static function plugin_initialize() {
3264
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3265
			Jetpack_Options::update_option( 'activated', 2 );
3266
		}
3267
3268 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3269
			$version = $old_version = JETPACK__VERSION . ':' . time();
3270
			/** This action is documented in class.jetpack.php */
3271
			do_action( 'updating_jetpack_version', $version, false );
3272
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3273
		}
3274
3275
		self::load_modules();
3276
3277
		Jetpack_Options::delete_option( 'do_activate' );
3278
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3279
	}
3280
3281
	/**
3282
	 * Removes all connection options
3283
	 *
3284
	 * @static
3285
	 */
3286
	public static function plugin_deactivation() {
3287
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3288
		$tracking = new Tracking();
3289
		$tracking->record_user_event( 'deactivate_plugin', array() );
3290
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3291
			Jetpack_Network::init()->deactivate();
3292
		} else {
3293
			self::disconnect( false );
3294
			// Jetpack_Heartbeat::init()->deactivate();
3295
		}
3296
	}
3297
3298
	/**
3299
	 * Disconnects from the Jetpack servers.
3300
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3301
	 *
3302
	 * @static
3303
	 */
3304
	public static function disconnect( $update_activated_state = true ) {
3305
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3306
3307
		$connection = self::connection();
3308
		$connection->clean_nonces( true );
3309
3310
		// If the site is in an IDC because sync is not allowed,
3311
		// let's make sure to not disconnect the production site.
3312
		if ( ! self::validate_sync_error_idc_option() ) {
3313
			$tracking = new Tracking();
3314
			$tracking->record_user_event( 'disconnect_site', array() );
3315
3316
			$connection->disconnect_site_wpcom( true );
3317
		}
3318
3319
		$connection->delete_all_connection_tokens( true );
3320
		Jetpack_IDC::clear_all_idc_options();
3321
3322
		if ( $update_activated_state ) {
3323
			Jetpack_Options::update_option( 'activated', 4 );
3324
		}
3325
3326
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3327
			// Check then record unique disconnection if site has never been disconnected previously
3328
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3329
				$jetpack_unique_connection['disconnected'] = 1;
3330
			} else {
3331
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3332
					// track unique disconnect
3333
					$jetpack = self::init();
3334
3335
					$jetpack->stat( 'connections', 'unique-disconnect' );
3336
					$jetpack->do_stats( 'server_side' );
3337
				}
3338
				// increment number of times disconnected
3339
				$jetpack_unique_connection['disconnected'] += 1;
3340
			}
3341
3342
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3343
		}
3344
3345
		// Delete all the sync related data. Since it could be taking up space.
3346
		Sender::get_instance()->uninstall();
3347
3348
	}
3349
3350
	/**
3351
	 * Unlinks the current user from the linked WordPress.com user.
3352
	 *
3353
	 * @deprecated since 7.7
3354
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3355
	 *
3356
	 * @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...
3357
	 * @return Boolean Whether the disconnection of the user was successful.
3358
	 */
3359
	public static function unlink_user( $user_id = null ) {
3360
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3361
		return Connection_Manager::disconnect_user( $user_id );
3362
	}
3363
3364
	/**
3365
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3366
	 */
3367
	public static function try_registration() {
3368
		$terms_of_service = new Terms_Of_Service();
3369
		// The user has agreed to the TOS at some point by now.
3370
		$terms_of_service->agree();
3371
3372
		// Let's get some testing in beta versions and such.
3373
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3374
			// Before attempting to connect, let's make sure that the domains are viable.
3375
			$domains_to_check = array_unique(
3376
				array(
3377
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3378
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3379
				)
3380
			);
3381
			foreach ( $domains_to_check as $domain ) {
3382
				$result = self::connection()->is_usable_domain( $domain );
0 ignored issues
show
Security Bug introduced by
It seems like $domain defined by $domain on line 3381 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...
3383
				if ( is_wp_error( $result ) ) {
3384
					return $result;
3385
				}
3386
			}
3387
		}
3388
3389
		$result = self::register();
3390
3391
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3392
		if ( ! $result || is_wp_error( $result ) ) {
3393
			return $result;
3394
		} else {
3395
			return true;
3396
		}
3397
	}
3398
3399
	/**
3400
	 * Tracking an internal event log. Try not to put too much chaff in here.
3401
	 *
3402
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3403
	 */
3404
	public static function log( $code, $data = null ) {
3405
		// only grab the latest 200 entries
3406
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3407
3408
		// Append our event to the log
3409
		$log_entry = array(
3410
			'time'    => time(),
3411
			'user_id' => get_current_user_id(),
3412
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3413
			'code'    => $code,
3414
		);
3415
		// Don't bother storing it unless we've got some.
3416
		if ( ! is_null( $data ) ) {
3417
			$log_entry['data'] = $data;
3418
		}
3419
		$log[] = $log_entry;
3420
3421
		// Try add_option first, to make sure it's not autoloaded.
3422
		// @todo: Add an add_option method to Jetpack_Options
3423
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3424
			Jetpack_Options::update_option( 'log', $log );
3425
		}
3426
3427
		/**
3428
		 * Fires when Jetpack logs an internal event.
3429
		 *
3430
		 * @since 3.0.0
3431
		 *
3432
		 * @param array $log_entry {
3433
		 *  Array of details about the log entry.
3434
		 *
3435
		 *  @param string time Time of the event.
3436
		 *  @param int user_id ID of the user who trigerred the event.
3437
		 *  @param int blog_id Jetpack Blog ID.
3438
		 *  @param string code Unique name for the event.
3439
		 *  @param string data Data about the event.
3440
		 * }
3441
		 */
3442
		do_action( 'jetpack_log_entry', $log_entry );
3443
	}
3444
3445
	/**
3446
	 * Get the internal event log.
3447
	 *
3448
	 * @param $event (string) - only return the specific log events
3449
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3450
	 *
3451
	 * @return array of log events || WP_Error for invalid params
3452
	 */
3453
	public static function get_log( $event = false, $num = false ) {
3454
		if ( $event && ! is_string( $event ) ) {
3455
			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...
3456
		}
3457
3458
		if ( $num && ! is_numeric( $num ) ) {
3459
			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...
3460
		}
3461
3462
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3463
3464
		// If nothing set - act as it did before, otherwise let's start customizing the output
3465
		if ( ! $num && ! $event ) {
3466
			return $entire_log;
3467
		} else {
3468
			$entire_log = array_reverse( $entire_log );
3469
		}
3470
3471
		$custom_log_output = array();
3472
3473
		if ( $event ) {
3474
			foreach ( $entire_log as $log_event ) {
3475
				if ( $event == $log_event['code'] ) {
3476
					$custom_log_output[] = $log_event;
3477
				}
3478
			}
3479
		} else {
3480
			$custom_log_output = $entire_log;
3481
		}
3482
3483
		if ( $num ) {
3484
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3485
		}
3486
3487
		return $custom_log_output;
3488
	}
3489
3490
	/**
3491
	 * Log modification of important settings.
3492
	 */
3493
	public static function log_settings_change( $option, $old_value, $value ) {
3494
		switch ( $option ) {
3495
			case 'jetpack_sync_non_public_post_stati':
3496
				self::log( $option, $value );
3497
				break;
3498
		}
3499
	}
3500
3501
	/**
3502
	 * Return stat data for WPCOM sync
3503
	 */
3504
	public static function get_stat_data( $encode = true, $extended = true ) {
3505
		$data = Jetpack_Heartbeat::generate_stats_array();
3506
3507
		if ( $extended ) {
3508
			$additional_data = self::get_additional_stat_data();
3509
			$data            = array_merge( $data, $additional_data );
3510
		}
3511
3512
		if ( $encode ) {
3513
			return json_encode( $data );
3514
		}
3515
3516
		return $data;
3517
	}
3518
3519
	/**
3520
	 * Get additional stat data to sync to WPCOM
3521
	 */
3522
	public static function get_additional_stat_data( $prefix = '' ) {
3523
		$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...
3524
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3525
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3526
		$return[ "{$prefix}site-count" ]    = 0;
3527
3528
		if ( function_exists( 'get_blog_count' ) ) {
3529
			$return[ "{$prefix}site-count" ] = get_blog_count();
3530
		}
3531
		return $return;
3532
	}
3533
3534
	private static function get_site_user_count() {
3535
		global $wpdb;
3536
3537
		if ( function_exists( 'wp_is_large_network' ) ) {
3538
			if ( wp_is_large_network( 'users' ) ) {
3539
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3540
			}
3541
		}
3542
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3543
			// It wasn't there, so regenerate the data and save the transient
3544
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3545
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3546
		}
3547
		return $user_count;
3548
	}
3549
3550
	/* Admin Pages */
3551
3552
	function admin_init() {
3553
		// If the plugin is not connected, display a connect message.
3554
		if (
3555
			// the plugin was auto-activated and needs its candy
3556
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3557
		||
3558
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3559
			! Jetpack_Options::get_option( 'activated' )
3560
		) {
3561
			self::plugin_initialize();
3562
		}
3563
3564
		$is_offline_mode = ( new Status() )->is_offline_mode();
3565
		if ( ! self::is_active() && ! $is_offline_mode ) {
3566
			Jetpack_Connection_Banner::init();
3567
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3568
			// Upgrade: 1.1 -> 1.1.1
3569
			// Check and see if host can verify the Jetpack servers' SSL certificate
3570
			$args = array();
3571
			Client::_wp_remote_request( self::connection()->api_url( 'test' ), $args, true );
3572
		}
3573
3574
		Jetpack_Wizard_Banner::init();
3575
3576
		if ( current_user_can( 'manage_options' ) && ! self::permit_ssl() ) {
3577
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3578
		}
3579
3580
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3581
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3582
		add_action( 'admin_enqueue_scripts', array( $this, 'deactivate_dialog' ) );
3583
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3584
3585
		if ( self::is_active() || $is_offline_mode ) {
3586
			// Artificially throw errors in certain specific cases during plugin activation.
3587
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3588
		}
3589
3590
		// Add custom column in wp-admin/users.php to show whether user is linked.
3591
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3592
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3593
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3594
	}
3595
3596
	function admin_body_class( $admin_body_class = '' ) {
3597
		$classes = explode( ' ', trim( $admin_body_class ) );
3598
3599
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3600
3601
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3602
		return " $admin_body_class ";
3603
	}
3604
3605
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3606
		return $admin_body_class . ' jetpack-pagestyles ';
3607
	}
3608
3609
	/**
3610
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3611
	 * This function artificially throws errors for such cases (per a specific list).
3612
	 *
3613
	 * @param string $plugin The activated plugin.
3614
	 */
3615
	function throw_error_on_activate_plugin( $plugin ) {
3616
		$active_modules = self::get_active_modules();
3617
3618
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3619
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3620
			$throw = false;
3621
3622
			// Try and make sure it really was the stats plugin
3623
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3624
				if ( 'stats.php' == basename( $plugin ) ) {
3625
					$throw = true;
3626
				}
3627
			} else {
3628
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3629
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3630
					$throw = true;
3631
				}
3632
			}
3633
3634
			if ( $throw ) {
3635
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3636
			}
3637
		}
3638
	}
3639
3640
	function intercept_plugin_error_scrape_init() {
3641
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3642
	}
3643
3644
	function intercept_plugin_error_scrape( $action, $result ) {
3645
		if ( ! $result ) {
3646
			return;
3647
		}
3648
3649
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3650
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3651
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3652
			}
3653
		}
3654
	}
3655
3656
	/**
3657
	 * Register the remote file upload request handlers, if needed.
3658
	 *
3659
	 * @access public
3660
	 */
3661
	public function add_remote_request_handlers() {
3662
		// Remote file uploads are allowed only via AJAX requests.
3663
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3664
			return;
3665
		}
3666
3667
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3668
		$remote_request_actions = array(
3669
			'jetpack_upload_file',
3670
			'jetpack_update_file',
3671
		);
3672
3673
		// phpcs:ignore WordPress.Security.NonceVerification
3674
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3675
			return;
3676
		}
3677
3678
		// Require Jetpack authentication for the remote file upload AJAX requests.
3679
		if ( ! $this->connection_manager ) {
3680
			$this->connection_manager = new Connection_Manager();
3681
		}
3682
3683
		$this->connection_manager->require_jetpack_authentication();
3684
3685
		// Register the remote file upload AJAX handlers.
3686
		foreach ( $remote_request_actions as $action ) {
3687
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3688
		}
3689
	}
3690
3691
	/**
3692
	 * Handler for Jetpack remote file uploads.
3693
	 *
3694
	 * @access public
3695
	 */
3696
	public function remote_request_handlers() {
3697
		$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...
3698
3699
		switch ( current_filter() ) {
3700
			case 'wp_ajax_nopriv_jetpack_upload_file':
3701
				$response = $this->upload_handler();
3702
				break;
3703
3704
			case 'wp_ajax_nopriv_jetpack_update_file':
3705
				$response = $this->upload_handler( true );
3706
				break;
3707
			default:
3708
				$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...
3709
				break;
3710
		}
3711
3712
		if ( ! $response ) {
3713
			$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...
3714
		}
3715
3716
		if ( is_wp_error( $response ) ) {
3717
			$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...
3718
			$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...
3719
			$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...
3720
3721
			if ( ! is_int( $status_code ) ) {
3722
				$status_code = 400;
3723
			}
3724
3725
			status_header( $status_code );
3726
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3727
		}
3728
3729
		status_header( 200 );
3730
		if ( true === $response ) {
3731
			exit;
3732
		}
3733
3734
		die( json_encode( (object) $response ) );
3735
	}
3736
3737
	/**
3738
	 * Uploads a file gotten from the global $_FILES.
3739
	 * If `$update_media_item` is true and `post_id` is defined
3740
	 * the attachment file of the media item (gotten through of the post_id)
3741
	 * will be updated instead of add a new one.
3742
	 *
3743
	 * @param  boolean $update_media_item - update media attachment
3744
	 * @return array - An array describing the uploadind files process
3745
	 */
3746
	function upload_handler( $update_media_item = false ) {
3747
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3748
			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...
3749
		}
3750
3751
		$user = wp_authenticate( '', '' );
3752
		if ( ! $user || is_wp_error( $user ) ) {
3753
			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...
3754
		}
3755
3756
		wp_set_current_user( $user->ID );
3757
3758
		if ( ! current_user_can( 'upload_files' ) ) {
3759
			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...
3760
		}
3761
3762
		if ( empty( $_FILES ) ) {
3763
			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...
3764
		}
3765
3766
		foreach ( array_keys( $_FILES ) as $files_key ) {
3767
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3768
				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...
3769
			}
3770
		}
3771
3772
		$media_keys = array_keys( $_FILES['media'] );
3773
3774
		$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...
3775
		if ( ! $token || is_wp_error( $token ) ) {
3776
			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...
3777
		}
3778
3779
		$uploaded_files = array();
3780
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3781
		unset( $GLOBALS['post'] );
3782
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3783
			$file = array();
3784
			foreach ( $media_keys as $media_key ) {
3785
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3786
			}
3787
3788
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3789
3790
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3791
			if ( $hmac_provided !== $hmac_file ) {
3792
				$uploaded_files[ $index ] = (object) array(
3793
					'error'             => 'invalid_hmac',
3794
					'error_description' => 'The corresponding HMAC for this file does not match',
3795
				);
3796
				continue;
3797
			}
3798
3799
			$_FILES['.jetpack.upload.'] = $file;
3800
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3801
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3802
				$post_id = 0;
3803
			}
3804
3805
			if ( $update_media_item ) {
3806
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3807
					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...
3808
				}
3809
3810
				$media_array = $_FILES['media'];
3811
3812
				$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...
3813
				$file_array['type']     = $media_array['type'][0];
3814
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3815
				$file_array['error']    = $media_array['error'][0];
3816
				$file_array['size']     = $media_array['size'][0];
3817
3818
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3819
3820
				if ( is_wp_error( $edited_media_item ) ) {
3821
					return $edited_media_item;
3822
				}
3823
3824
				$response = (object) array(
3825
					'id'   => (string) $post_id,
3826
					'file' => (string) $edited_media_item->post_title,
3827
					'url'  => (string) wp_get_attachment_url( $post_id ),
3828
					'type' => (string) $edited_media_item->post_mime_type,
3829
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3830
				);
3831
3832
				return (array) array( $response );
3833
			}
3834
3835
			$attachment_id = media_handle_upload(
3836
				'.jetpack.upload.',
3837
				$post_id,
3838
				array(),
3839
				array(
3840
					'action' => 'jetpack_upload_file',
3841
				)
3842
			);
3843
3844
			if ( ! $attachment_id ) {
3845
				$uploaded_files[ $index ] = (object) array(
3846
					'error'             => 'unknown',
3847
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3848
				);
3849
			} elseif ( is_wp_error( $attachment_id ) ) {
3850
				$uploaded_files[ $index ] = (object) array(
3851
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3852
					'error_description' => $attachment_id->get_error_message(),
3853
				);
3854
			} else {
3855
				$attachment               = get_post( $attachment_id );
3856
				$uploaded_files[ $index ] = (object) array(
3857
					'id'   => (string) $attachment_id,
3858
					'file' => $attachment->post_title,
3859
					'url'  => wp_get_attachment_url( $attachment_id ),
3860
					'type' => $attachment->post_mime_type,
3861
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3862
				);
3863
				// Zip files uploads are not supported unless they are done for installation purposed
3864
				// lets delete them in case something goes wrong in this whole process
3865
				if ( 'application/zip' === $attachment->post_mime_type ) {
3866
					// Schedule a cleanup for 2 hours from now in case of failed install.
3867
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3868
				}
3869
			}
3870
		}
3871
		if ( ! is_null( $global_post ) ) {
3872
			$GLOBALS['post'] = $global_post;
3873
		}
3874
3875
		return $uploaded_files;
3876
	}
3877
3878
	/**
3879
	 * Add help to the Jetpack page
3880
	 *
3881
	 * @since Jetpack (1.2.3)
3882
	 * @return false if not the Jetpack page
3883
	 */
3884
	function admin_help() {
3885
		$current_screen = get_current_screen();
3886
3887
		// Overview
3888
		$current_screen->add_help_tab(
3889
			array(
3890
				'id'      => 'home',
3891
				'title'   => __( 'Home', 'jetpack' ),
3892
				'content' =>
3893
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3894
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3895
					'<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>',
3896
			)
3897
		);
3898
3899
		// Screen Content
3900
		if ( current_user_can( 'manage_options' ) ) {
3901
			$current_screen->add_help_tab(
3902
				array(
3903
					'id'      => 'settings',
3904
					'title'   => __( 'Settings', 'jetpack' ),
3905
					'content' =>
3906
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3907
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3908
						'<ol>' .
3909
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3910
							'<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>' .
3911
						'</ol>' .
3912
						'<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>',
3913
				)
3914
			);
3915
		}
3916
3917
		// Help Sidebar
3918
		$support_url = Redirect::get_url( 'jetpack-support' );
3919
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
3920
		$current_screen->set_help_sidebar(
3921
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3922
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3923
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3924
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3925
		);
3926
	}
3927
3928
	function admin_menu_css() {
3929
		wp_enqueue_style( 'jetpack-icons' );
3930
	}
3931
3932
	function admin_menu_order() {
3933
		return true;
3934
	}
3935
3936
	function jetpack_menu_order( $menu_order ) {
3937
		$jp_menu_order = array();
3938
3939
		foreach ( $menu_order as $index => $item ) {
3940
			if ( $item != 'jetpack' ) {
3941
				$jp_menu_order[] = $item;
3942
			}
3943
3944
			if ( $index == 0 ) {
3945
				$jp_menu_order[] = 'jetpack';
3946
			}
3947
		}
3948
3949
		return $jp_menu_order;
3950
	}
3951
3952
	function admin_banner_styles() {
3953
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3954
3955 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3956
			wp_register_style(
3957
				'jetpack-dops-style',
3958
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3959
				array(),
3960
				JETPACK__VERSION
3961
			);
3962
		}
3963
3964
		wp_enqueue_style(
3965
			'jetpack',
3966
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3967
			array( 'jetpack-dops-style' ),
3968
			JETPACK__VERSION . '-20121016'
3969
		);
3970
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3971
		wp_style_add_data( 'jetpack', 'suffix', $min );
3972
	}
3973
3974
	function plugin_action_links( $actions ) {
3975
3976
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3977
3978
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_offline_mode() ) ) {
3979
			return array_merge(
3980
				$jetpack_home,
3981
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3982
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3983
				$actions
3984
			);
3985
		}
3986
3987
		return array_merge( $jetpack_home, $actions );
3988
	}
3989
3990
	/**
3991
	 * Adds the deactivation warning modal if there are other active plugins using the connection
3992
	 *
3993
	 * @param string $hook The current admin page.
3994
	 *
3995
	 * @return void
3996
	 */
3997
	public function deactivate_dialog( $hook ) {
3998
		if (
3999
			'plugins.php' === $hook
4000
			&& self::is_active()
4001
		) {
4002
4003
			$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4004
4005
			if ( count( $active_plugins_using_connection ) > 1 ) {
4006
4007
				add_thickbox();
4008
4009
				wp_register_script(
4010
					'jp-tracks',
4011
					'//stats.wp.com/w.js',
4012
					array(),
4013
					gmdate( 'YW' ),
4014
					true
4015
				);
4016
4017
				wp_register_script(
4018
					'jp-tracks-functions',
4019
					plugins_url( '_inc/lib/tracks/tracks-callables.js', JETPACK__PLUGIN_FILE ),
4020
					array( 'jp-tracks' ),
4021
					JETPACK__VERSION,
4022
					false
4023
				);
4024
4025
				wp_enqueue_script(
4026
					'jetpack-deactivate-dialog-js',
4027
					Assets::get_file_url_for_environment(
4028
						'_inc/build/jetpack-deactivate-dialog.min.js',
4029
						'_inc/jetpack-deactivate-dialog.js'
4030
					),
4031
					array( 'jquery', 'jp-tracks-functions' ),
4032
					JETPACK__VERSION,
4033
					true
4034
				);
4035
4036
				wp_localize_script(
4037
					'jetpack-deactivate-dialog-js',
4038
					'deactivate_dialog',
4039
					array(
4040
						'title'            => __( 'Deactivate Jetpack', 'jetpack' ),
4041
						'deactivate_label' => __( 'Disconnect and Deactivate', 'jetpack' ),
4042
						'tracksUserData'   => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
4043
					)
4044
				);
4045
4046
				add_action( 'admin_footer', array( $this, 'deactivate_dialog_content' ) );
4047
4048
				wp_enqueue_style( 'jetpack-deactivate-dialog', plugins_url( 'css/jetpack-deactivate-dialog.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
4049
			}
4050
		}
4051
	}
4052
4053
	/**
4054
	 * Outputs the content of the deactivation modal
4055
	 *
4056
	 * @return void
4057
	 */
4058
	public function deactivate_dialog_content() {
4059
		$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4060
		unset( $active_plugins_using_connection['jetpack'] );
4061
		$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 4059 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...
4062
	}
4063
4064
	/**
4065
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4066
	 *
4067
	 * @param string $login_url The wp-login URL.
4068
	 * @param string $redirect  URL to redirect users after logging in.
4069
	 * @since Jetpack 8.4
4070
	 * @return string
4071
	 */
4072
	public function login_url( $login_url, $redirect ) {
4073
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
4074
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4075
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4076
		}
4077
		return $login_url;
4078
	}
4079
4080
	/**
4081
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4082
	 *
4083
	 * @since Jetpack 8.4
4084
	 */
4085
	public function login_init() {
4086
		// phpcs:ignore WordPress.Security.NonceVerification
4087
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4088
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4089
			wp_safe_redirect(
4090
				add_query_arg(
4091
					array(
4092
						'forceInstall' => 1,
4093
						'url'          => rawurlencode( get_site_url() ),
4094
					),
4095
					// @todo provide way to go to specific calypso env.
4096
					self::get_calypso_host() . 'jetpack/connect'
4097
				)
4098
			);
4099
			exit;
4100
		}
4101
	}
4102
4103
	/*
4104
	 * Registration flow:
4105
	 * 1 - ::admin_page_load() action=register
4106
	 * 2 - ::try_registration()
4107
	 * 3 - ::register()
4108
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4109
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4110
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4111
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4112
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4113
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4114
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4115
	 *       jetpack_id, jetpack_secret, jetpack_public
4116
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4117
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4118
	 * 5 - user logs in with WP.com account
4119
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4120
	 *		- Manager::authorize()
4121
	 *		- Manager::get_token()
4122
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4123
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4124
	 *			- which responds with access_token, token_type, scope
4125
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4126
	 *		- Jetpack::activate_default_modules()
4127
	 *     		- Deactivates deprecated plugins
4128
	 *     		- Activates all default modules
4129
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4130
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4131
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4132
	 *     Done!
4133
	 */
4134
4135
	/**
4136
	 * Handles the page load events for the Jetpack admin page
4137
	 */
4138
	function admin_page_load() {
4139
		$error = false;
4140
4141
		// Make sure we have the right body class to hook stylings for subpages off of.
4142
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4143
4144
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4145
			// Should only be used in intermediate redirects to preserve state across redirects
4146
			self::restate();
4147
		}
4148
4149
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4150
			// @todo: Add validation against a known allowed list.
4151
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4152
			// User clicked in the iframe to link their accounts
4153
			if ( ! self::is_user_connected() ) {
4154
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4155
4156
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4157
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4158
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4159
4160
				if ( isset( $_GET['notes_iframe'] ) ) {
4161
					$connect_url .= '&notes_iframe';
4162
				}
4163
				wp_redirect( $connect_url );
4164
				exit;
4165
			} else {
4166
				if ( ! isset( $_GET['calypso_env'] ) ) {
4167
					self::state( 'message', 'already_authorized' );
4168
					wp_safe_redirect( self::admin_url() );
4169
					exit;
4170
				} else {
4171
					$connect_url  = $this->build_connect_url( true, false, $from );
4172
					$connect_url .= '&already_authorized=true';
4173
					wp_redirect( $connect_url );
4174
					exit;
4175
				}
4176
			}
4177
		}
4178
4179
		if ( isset( $_GET['action'] ) ) {
4180
			switch ( $_GET['action'] ) {
4181
				case 'authorize':
4182
					if ( self::is_active() && self::is_user_connected() ) {
4183
						self::state( 'message', 'already_authorized' );
4184
						wp_safe_redirect( self::admin_url() );
4185
						exit;
4186
					}
4187
					self::log( 'authorize' );
4188
					$client_server = new Jetpack_Client_Server();
4189
					$client_server->client_authorize();
4190
					exit;
4191
				case 'register':
4192
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4193
						$error = 'cheatin';
4194
						break;
4195
					}
4196
					check_admin_referer( 'jetpack-register' );
4197
					self::log( 'register' );
4198
					self::maybe_set_version_option();
4199
					$registered = self::try_registration();
4200 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4201
						$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...
4202
						self::state( 'error', $error );
4203
						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...
4204
4205
						/**
4206
						 * Jetpack registration Error.
4207
						 *
4208
						 * @since 7.5.0
4209
						 *
4210
						 * @param string|int $error The error code.
4211
						 * @param \WP_Error $registered The error object.
4212
						 */
4213
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4214
						break;
4215
					}
4216
4217
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4218
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4219
4220
					/**
4221
					 * Jetpack registration Success.
4222
					 *
4223
					 * @since 7.5.0
4224
					 *
4225
					 * @param string $from 'from' GET parameter;
4226
					 */
4227
					do_action( 'jetpack_connection_register_success', $from );
4228
4229
					$url = $this->build_connect_url( true, $redirect, $from );
4230
4231
					if ( ! empty( $_GET['onboarding'] ) ) {
4232
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4233
					}
4234
4235
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4236
						$url = add_query_arg( 'auth_approved', 'true', $url );
4237
					}
4238
4239
					wp_redirect( $url );
4240
					exit;
4241
				case 'activate':
4242
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4243
						$error = 'cheatin';
4244
						break;
4245
					}
4246
4247
					$module = stripslashes( $_GET['module'] );
4248
					check_admin_referer( "jetpack_activate-$module" );
4249
					self::log( 'activate', $module );
4250
					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...
4251
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4252
					}
4253
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4254
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4255
					exit;
4256
				case 'activate_default_modules':
4257
					check_admin_referer( 'activate_default_modules' );
4258
					self::log( 'activate_default_modules' );
4259
					self::restate();
4260
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4261
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4262
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4263
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4264
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4265
					exit;
4266
				case 'disconnect':
4267
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4268
						$error = 'cheatin';
4269
						break;
4270
					}
4271
4272
					check_admin_referer( 'jetpack-disconnect' );
4273
					self::log( 'disconnect' );
4274
					self::disconnect();
4275
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4276
					exit;
4277
				case 'reconnect':
4278
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4279
						$error = 'cheatin';
4280
						break;
4281
					}
4282
4283
					check_admin_referer( 'jetpack-reconnect' );
4284
					self::log( 'reconnect' );
4285
					$this->disconnect();
4286
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4287
					exit;
4288 View Code Duplication
				case 'deactivate':
4289
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4290
						$error = 'cheatin';
4291
						break;
4292
					}
4293
4294
					$modules = stripslashes( $_GET['module'] );
4295
					check_admin_referer( "jetpack_deactivate-$modules" );
4296
					foreach ( explode( ',', $modules ) as $module ) {
4297
						self::log( 'deactivate', $module );
4298
						self::deactivate_module( $module );
4299
						self::state( 'message', 'module_deactivated' );
4300
					}
4301
					self::state( 'module', $modules );
4302
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4303
					exit;
4304
				case 'unlink':
4305
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4306
					check_admin_referer( 'jetpack-unlink' );
4307
					self::log( 'unlink' );
4308
					Connection_Manager::disconnect_user();
4309
					self::state( 'message', 'unlinked' );
4310
					if ( 'sub-unlink' == $redirect ) {
4311
						wp_safe_redirect( admin_url() );
4312
					} else {
4313
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4314
					}
4315
					exit;
4316
				case 'onboard':
4317
					if ( ! current_user_can( 'manage_options' ) ) {
4318
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4319
					} else {
4320
						self::create_onboarding_token();
4321
						$url = $this->build_connect_url( true );
4322
4323
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4324
							$url = add_query_arg( 'onboarding', $token, $url );
4325
						}
4326
4327
						$calypso_env = $this->get_calypso_env();
4328
						if ( ! empty( $calypso_env ) ) {
4329
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4330
						}
4331
4332
						wp_redirect( $url );
4333
						exit;
4334
					}
4335
					exit;
4336
				default:
4337
					/**
4338
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4339
					 *
4340
					 * @since 2.6.0
4341
					 *
4342
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4343
					 */
4344
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4345
			}
4346
		}
4347
4348
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4349
			self::activate_new_modules( true );
4350
		}
4351
4352
		$message_code = self::state( 'message' );
4353
		if ( self::state( 'optin-manage' ) ) {
4354
			$activated_manage = $message_code;
4355
			$message_code     = 'jetpack-manage';
4356
		}
4357
4358
		switch ( $message_code ) {
4359
			case 'jetpack-manage':
4360
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4361
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4362
				$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>';
4363
				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...
4364
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4365
				}
4366
				break;
4367
4368
		}
4369
4370
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4371
4372
		if ( ! empty( $deactivated_plugins ) ) {
4373
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4374
			$deactivated_titles  = array();
4375
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4376
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4377
					continue;
4378
				}
4379
4380
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4381
			}
4382
4383
			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...
4384
				if ( $this->message ) {
4385
					$this->message .= "<br /><br />\n";
4386
				}
4387
4388
				$this->message .= wp_sprintf(
4389
					_n(
4390
						'Jetpack contains the most recent version of the old %l plugin.',
4391
						'Jetpack contains the most recent versions of the old %l plugins.',
4392
						count( $deactivated_titles ),
4393
						'jetpack'
4394
					),
4395
					$deactivated_titles
4396
				);
4397
4398
				$this->message .= "<br />\n";
4399
4400
				$this->message .= _n(
4401
					'The old version has been deactivated and can be removed from your site.',
4402
					'The old versions have been deactivated and can be removed from your site.',
4403
					count( $deactivated_titles ),
4404
					'jetpack'
4405
				);
4406
			}
4407
		}
4408
4409
		$this->privacy_checks = self::state( 'privacy_checks' );
4410
4411
		if ( $this->message || $this->error || $this->privacy_checks ) {
4412
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4413
		}
4414
4415
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4416
	}
4417
4418
	function admin_notices() {
4419
4420
		if ( $this->error ) {
4421
			?>
4422
<div id="message" class="jetpack-message jetpack-err">
4423
	<div class="squeezer">
4424
		<h2>
4425
			<?php
4426
			echo wp_kses(
4427
				$this->error,
4428
				array(
4429
					'a'      => array( 'href' => array() ),
4430
					'small'  => true,
4431
					'code'   => true,
4432
					'strong' => true,
4433
					'br'     => true,
4434
					'b'      => true,
4435
				)
4436
			);
4437
			?>
4438
			</h2>
4439
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4440
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4441
<?php	endif; ?>
4442
	</div>
4443
</div>
4444
			<?php
4445
		}
4446
4447
		if ( $this->message ) {
4448
			?>
4449
<div id="message" class="jetpack-message">
4450
	<div class="squeezer">
4451
		<h2>
4452
			<?php
4453
			echo wp_kses(
4454
				$this->message,
4455
				array(
4456
					'strong' => array(),
4457
					'a'      => array( 'href' => true ),
4458
					'br'     => true,
4459
				)
4460
			);
4461
			?>
4462
			</h2>
4463
	</div>
4464
</div>
4465
			<?php
4466
		}
4467
4468
		if ( $this->privacy_checks ) :
4469
			$module_names = $module_slugs = array();
4470
4471
			$privacy_checks = explode( ',', $this->privacy_checks );
4472
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4473
			foreach ( $privacy_checks as $module_slug ) {
4474
				$module = self::get_module( $module_slug );
4475
				if ( ! $module ) {
4476
					continue;
4477
				}
4478
4479
				$module_slugs[] = $module_slug;
4480
				$module_names[] = "<strong>{$module['name']}</strong>";
4481
			}
4482
4483
			$module_slugs = join( ',', $module_slugs );
4484
			?>
4485
<div id="message" class="jetpack-message jetpack-err">
4486
	<div class="squeezer">
4487
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4488
		<p>
4489
			<?php
4490
			echo wp_kses(
4491
				wptexturize(
4492
					wp_sprintf(
4493
						_nx(
4494
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4495
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4496
							count( $privacy_checks ),
4497
							'%l = list of Jetpack module/feature names',
4498
							'jetpack'
4499
						),
4500
						$module_names
4501
					)
4502
				),
4503
				array( 'strong' => true )
4504
			);
4505
4506
			echo "\n<br />\n";
4507
4508
			echo wp_kses(
4509
				sprintf(
4510
					_nx(
4511
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4512
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4513
						count( $privacy_checks ),
4514
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4515
						'jetpack'
4516
					),
4517
					wp_nonce_url(
4518
						self::admin_url(
4519
							array(
4520
								'page'   => 'jetpack',
4521
								'action' => 'deactivate',
4522
								'module' => urlencode( $module_slugs ),
4523
							)
4524
						),
4525
						"jetpack_deactivate-$module_slugs"
4526
					),
4527
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4528
				),
4529
				array(
4530
					'a' => array(
4531
						'href'  => true,
4532
						'title' => true,
4533
					),
4534
				)
4535
			);
4536
			?>
4537
		</p>
4538
	</div>
4539
</div>
4540
			<?php
4541
endif;
4542
	}
4543
4544
	/**
4545
	 * We can't always respond to a signed XML-RPC request with a
4546
	 * helpful error message. In some circumstances, doing so could
4547
	 * leak information.
4548
	 *
4549
	 * Instead, track that the error occurred via a Jetpack_Option,
4550
	 * and send that data back in the heartbeat.
4551
	 * All this does is increment a number, but it's enough to find
4552
	 * trends.
4553
	 *
4554
	 * @param WP_Error $xmlrpc_error The error produced during
4555
	 *                               signature validation.
4556
	 */
4557
	function track_xmlrpc_error( $xmlrpc_error ) {
4558
		$code = is_wp_error( $xmlrpc_error )
4559
			? $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...
4560
			: 'should-not-happen';
4561
4562
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4563
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4564
			// No need to update the option if we already have
4565
			// this code stored.
4566
			return;
4567
		}
4568
		$xmlrpc_errors[ $code ] = true;
4569
4570
		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...
4571
	}
4572
4573
	/**
4574
	 * Initialize the jetpack stats instance only when needed
4575
	 *
4576
	 * @return void
4577
	 */
4578
	private function initialize_stats() {
4579
		if ( is_null( $this->a8c_mc_stats_instance ) ) {
4580
			$this->a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4581
		}
4582
	}
4583
4584
	/**
4585
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4586
	 */
4587
	function stat( $group, $detail ) {
4588
		$this->initialize_stats();
4589
		$this->a8c_mc_stats_instance->add( $group, $detail );
4590
4591
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4592
		$this->stats = $this->a8c_mc_stats_instance->get_current_stats();
4593
	}
4594
4595
	/**
4596
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4597
	 */
4598
	function do_stats( $method = '' ) {
4599
		$this->initialize_stats();
4600
		if ( 'server_side' === $method ) {
4601
			$this->a8c_mc_stats_instance->do_server_side_stats();
4602
		} else {
4603
			$this->a8c_mc_stats_instance->do_stats();
4604
		}
4605
4606
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4607
		$this->stats = array();
4608
	}
4609
4610
	/**
4611
	 * Runs stats code for a one-off, server-side.
4612
	 *
4613
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4614
	 *
4615
	 * @return bool If it worked.
4616
	 */
4617
	static function do_server_side_stat( $args ) {
4618
		$url                   = self::build_stats_url( $args );
4619
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4620
		return $a8c_mc_stats_instance->do_server_side_stat( $url );
4621
	}
4622
4623
	/**
4624
	 * Builds the stats url.
4625
	 *
4626
	 * @param $args array|string The arguments to append to the URL.
4627
	 *
4628
	 * @return string The URL to be pinged.
4629
	 */
4630
	static function build_stats_url( $args ) {
4631
4632
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4633
		return $a8c_mc_stats_instance->build_stats_url( $args );
4634
4635
	}
4636
4637
	/**
4638
	 * Get the role of the current user.
4639
	 *
4640
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4641
	 *
4642
	 * @access public
4643
	 * @static
4644
	 *
4645
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4646
	 */
4647
	public static function translate_current_user_to_role() {
4648
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4649
4650
		$roles = new Roles();
4651
		return $roles->translate_current_user_to_role();
4652
	}
4653
4654
	/**
4655
	 * Get the role of a particular user.
4656
	 *
4657
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4658
	 *
4659
	 * @access public
4660
	 * @static
4661
	 *
4662
	 * @param \WP_User $user User object.
4663
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4664
	 */
4665
	public static function translate_user_to_role( $user ) {
4666
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4667
4668
		$roles = new Roles();
4669
		return $roles->translate_user_to_role( $user );
4670
	}
4671
4672
	/**
4673
	 * Get the minimum capability for a role.
4674
	 *
4675
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4676
	 *
4677
	 * @access public
4678
	 * @static
4679
	 *
4680
	 * @param string $role Role name.
4681
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4682
	 */
4683
	public static function translate_role_to_cap( $role ) {
4684
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4685
4686
		$roles = new Roles();
4687
		return $roles->translate_role_to_cap( $role );
4688
	}
4689
4690
	/**
4691
	 * Sign a user role with the master access token.
4692
	 * If not specified, will default to the current user.
4693
	 *
4694
	 * @deprecated since 7.7
4695
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4696
	 *
4697
	 * @access public
4698
	 * @static
4699
	 *
4700
	 * @param string $role    User role.
4701
	 * @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...
4702
	 * @return string Signed user role.
4703
	 */
4704
	public static function sign_role( $role, $user_id = null ) {
4705
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4706
		return self::connection()->sign_role( $role, $user_id );
4707
	}
4708
4709
	/**
4710
	 * Builds a URL to the Jetpack connection auth page
4711
	 *
4712
	 * @since 3.9.5
4713
	 *
4714
	 * @param bool        $raw If true, URL will not be escaped.
4715
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4716
	 *                              If string, will be a custom redirect.
4717
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4718
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4719
	 *
4720
	 * @return string Connect URL
4721
	 */
4722
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4723
		$site_id    = Jetpack_Options::get_option( 'id' );
4724
		$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...
4725
4726
		if ( $register || ! $blog_token || ! $site_id ) {
4727
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4728
4729
			if ( ! empty( $redirect ) ) {
4730
				$url = add_query_arg(
4731
					'redirect',
4732
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4733
					$url
4734
				);
4735
			}
4736
4737
			if ( is_network_admin() ) {
4738
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4739
			}
4740
4741
			$calypso_env = self::get_calypso_env();
4742
4743
			if ( ! empty( $calypso_env ) ) {
4744
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4745
			}
4746
		} else {
4747
4748
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4749
			// because otherwise this logic can get us in to a loop.
4750
			$last_connect_url_check = (int) Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' );
4751
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4752
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4753
4754
				$response = Client::wpcom_json_api_request_as_blog(
4755
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4756
					'1.1'
4757
				);
4758
4759
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4760
4761
					// Generating a register URL instead to refresh the existing token
4762
					return $this->build_connect_url( $raw, $redirect, $from, true );
4763
				}
4764
			}
4765
4766
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4722 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...
4767
		}
4768
4769
		if ( $from ) {
4770
			$url = add_query_arg( 'from', $from, $url );
4771
		}
4772
4773
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4774
		/**
4775
		 * Filter the URL used when connecting a user to a WordPress.com account.
4776
		 *
4777
		 * @since 8.1.0
4778
		 *
4779
		 * @param string $url Connection URL.
4780
		 * @param bool   $raw If true, URL will not be escaped.
4781
		 */
4782
		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...
4783
	}
4784
4785
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4786
4787
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4788
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4789
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4790
4791
		if ( $iframe ) {
4792
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4793
		}
4794
4795
		$c8n = self::connection();
4796
		$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...
4797
4798
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4799
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4800
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4801
4802
		if ( $iframe ) {
4803
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4804
		}
4805
4806
		/**
4807
		 * Filter the URL used when authorizing a user to a WordPress.com account.
4808
		 *
4809
		 * @since 8.9.0
4810
		 *
4811
		 * @param string $url Connection URL.
4812
		 */
4813
		return apply_filters( 'jetpack_build_authorize_url', $url );
4814
	}
4815
4816
	/**
4817
	 * Filters the connection URL parameter array.
4818
	 *
4819
	 * @param array $args default URL parameters used by the package.
4820
	 * @return array the modified URL arguments array.
4821
	 */
4822
	public static function filter_connect_request_body( $args ) {
4823
		if (
4824
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4825
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4826
		) {
4827
			$gp_locale      = GP_Locales::by_field( 'wp_locale', get_locale() );
4828
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4829
				? $gp_locale->slug
4830
				: '';
4831
		}
4832
4833
		$tracking        = new Tracking();
4834
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4835
4836
		$args = array_merge(
4837
			$args,
4838
			array(
4839
				'_ui' => $tracks_identity['_ui'],
4840
				'_ut' => $tracks_identity['_ut'],
4841
			)
4842
		);
4843
4844
		$calypso_env = self::get_calypso_env();
4845
4846
		if ( ! empty( $calypso_env ) ) {
4847
			$args['calypso_env'] = $calypso_env;
4848
		}
4849
4850
		return $args;
4851
	}
4852
4853
	/**
4854
	 * Filters the URL that will process the connection data. It can be different from the URL
4855
	 * that we send the user to after everything is done.
4856
	 *
4857
	 * @param String $processing_url the default redirect URL used by the package.
4858
	 * @return String the modified URL.
4859
	 */
4860
	public static function filter_connect_processing_url( $processing_url ) {
4861
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4862
		return $processing_url;
4863
	}
4864
4865
	/**
4866
	 * Filters the redirection URL that is used for connect requests. The redirect
4867
	 * URL should return the user back to the Jetpack console.
4868
	 *
4869
	 * @param String $redirect the default redirect URL used by the package.
4870
	 * @return String the modified URL.
4871
	 */
4872
	public static function filter_connect_redirect_url( $redirect ) {
4873
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4874
		$redirect           = $redirect
4875
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4876
			: $jetpack_admin_page;
4877
4878
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4879
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4880
		}
4881
4882
		return $redirect;
4883
	}
4884
4885
	/**
4886
	 * This action fires at the beginning of the Manager::authorize method.
4887
	 */
4888
	public static function authorize_starting() {
4889
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4890
		// Checking if site has been active/connected previously before recording unique connection.
4891
		if ( ! $jetpack_unique_connection ) {
4892
			// jetpack_unique_connection option has never been set.
4893
			$jetpack_unique_connection = array(
4894
				'connected'    => 0,
4895
				'disconnected' => 0,
4896
				'version'      => '3.6.1',
4897
			);
4898
4899
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4900
4901
			// Track unique connection.
4902
			$jetpack = self::init();
4903
4904
			$jetpack->stat( 'connections', 'unique-connection' );
4905
			$jetpack->do_stats( 'server_side' );
4906
		}
4907
4908
		// Increment number of times connected.
4909
		$jetpack_unique_connection['connected'] += 1;
4910
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4911
	}
4912
4913
	/**
4914
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4915
	 * linked.
4916
	 */
4917
	public static function authorize_ending_linked() {
4918
		// Don't activate anything since we are just connecting a user.
4919
		self::state( 'message', 'linked' );
4920
	}
4921
4922
	/**
4923
	 * This action fires at the end of the Manager::authorize method when the master user is
4924
	 * authorized.
4925
	 *
4926
	 * @param array $data The request data.
4927
	 */
4928
	public static function authorize_ending_authorized( $data ) {
4929
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4930
		self::invalidate_onboarding_token();
4931
4932
		// If redirect_uri is SSO, ensure SSO module is enabled.
4933
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
4934
4935
		/** This filter is documented in class.jetpack-cli.php */
4936
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4937
4938
		$activate_sso = (
4939
			isset( $redirect_options['action'] ) &&
4940
			'jetpack-sso' === $redirect_options['action'] &&
4941
			$jetpack_start_enable_sso
4942
		);
4943
4944
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4945
4946
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4947
	}
4948
4949
	/**
4950
	 * This action fires at the end of the REST_Connector connection_reconnect method when the
4951
	 * reconnect process is completed.
4952
	 * Note that this currently only happens when we don't need the user to re-authorize
4953
	 * their WP.com account, eg in cases where we are restoring a connection with
4954
	 * unhealthy blog token.
4955
	 */
4956
	public static function reconnection_completed() {
4957
		self::state( 'message', 'reconnection_completed' );
4958
	}
4959
4960
	/**
4961
	 * Get our assumed site creation date.
4962
	 * Calculated based on the earlier date of either:
4963
	 * - Earliest admin user registration date.
4964
	 * - Earliest date of post of any post type.
4965
	 *
4966
	 * @since 7.2.0
4967
	 * @deprecated since 7.8.0
4968
	 *
4969
	 * @return string Assumed site creation date and time.
4970
	 */
4971
	public static function get_assumed_site_creation_date() {
4972
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4973
		return self::connection()->get_assumed_site_creation_date();
4974
	}
4975
4976 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4977
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4978
4979
		if ( $activation_source_name ) {
4980
			$args['_as'] = urlencode( $activation_source_name );
4981
		}
4982
4983
		if ( $activation_source_keyword ) {
4984
			$args['_ak'] = urlencode( $activation_source_keyword );
4985
		}
4986
	}
4987
4988
	function build_reconnect_url( $raw = false ) {
4989
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4990
		return $raw ? $url : esc_url( $url );
4991
	}
4992
4993
	public static function admin_url( $args = null ) {
4994
		$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...
4995
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4996
		return $url;
4997
	}
4998
4999
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
5000
		$actionurl = str_replace( '&amp;', '&', $actionurl );
5001
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
5002
	}
5003
5004
	function dismiss_jetpack_notice() {
5005
5006
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
5007
			return;
5008
		}
5009
5010
		switch ( $_GET['jetpack-notice'] ) {
5011
			case 'dismiss':
5012
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
5013
5014
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
5015
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
5016
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
5017
				}
5018
				break;
5019
		}
5020
	}
5021
5022
	public static function sort_modules( $a, $b ) {
5023
		if ( $a['sort'] == $b['sort'] ) {
5024
			return 0;
5025
		}
5026
5027
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
5028
	}
5029
5030
	function ajax_recheck_ssl() {
5031
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5032
		$result = self::permit_ssl( true );
5033
		wp_send_json(
5034
			array(
5035
				'enabled' => $result,
5036
				'message' => get_transient( 'jetpack_https_test_message' ),
5037
			)
5038
		);
5039
	}
5040
5041
	/* Client API */
5042
5043
	/**
5044
	 * Returns the requested Jetpack API URL
5045
	 *
5046
	 * @deprecated since 7.7
5047
	 * @return string
5048
	 */
5049
	public static function api_url( $relative_url ) {
5050
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5051
		$connection = self::connection();
5052
		return $connection->api_url( $relative_url );
5053
	}
5054
5055
	/**
5056
	 * @deprecated 8.0
5057
	 *
5058
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requests.
5059
	 * But we no longer fix "bad hosts" anyway, outbound HTTPS is required for Jetpack to function.
5060
	 */
5061
	public static function fix_url_for_bad_hosts( $url ) {
5062
		_deprecated_function( __METHOD__, 'jetpack-8.0' );
5063
		return $url;
5064
	}
5065
5066
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5067
		// Default to a blog token.
5068
		$token_type = 'blog';
5069
5070
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5071
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5072
			if ( ! empty( $_GET['onboarding'] ) ) {
5073
				$jpo = $_GET;
5074
			} else {
5075
				$jpo = json_decode( $request_data, true );
5076
			}
5077
5078
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5079
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5080
5081
			if (
5082
				isset( $jpo_user )
5083
				&& isset( $jpo_token )
5084
				&& is_email( $jpo_user )
5085
				&& ctype_alnum( $jpo_token )
5086
				&& isset( $_GET['rest_route'] )
5087
				&& self::validate_onboarding_token_action(
5088
					$jpo_token,
5089
					$_GET['rest_route']
5090
				)
5091
			) {
5092
				$jp_user = get_user_by( 'email', $jpo_user );
5093
				if ( is_a( $jp_user, 'WP_User' ) ) {
5094
					wp_set_current_user( $jp_user->ID );
5095
					$user_can = is_multisite()
5096
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5097
						: current_user_can( 'manage_options' );
5098
					if ( $user_can ) {
5099
						$token_type              = 'user';
5100
						$token->external_user_id = $jp_user->ID;
5101
					}
5102
				}
5103
			}
5104
5105
			$token_data['type']    = $token_type;
5106
			$token_data['user_id'] = $token->external_user_id;
5107
		}
5108
5109
		return $token_data;
5110
	}
5111
5112
	/**
5113
	 * Create a random secret for validating onboarding payload
5114
	 *
5115
	 * @return string Secret token
5116
	 */
5117
	public static function create_onboarding_token() {
5118
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5119
			$token = wp_generate_password( 32, false );
5120
			Jetpack_Options::update_option( 'onboarding', $token );
5121
		}
5122
5123
		return $token;
5124
	}
5125
5126
	/**
5127
	 * Remove the onboarding token
5128
	 *
5129
	 * @return bool True on success, false on failure
5130
	 */
5131
	public static function invalidate_onboarding_token() {
5132
		return Jetpack_Options::delete_option( 'onboarding' );
5133
	}
5134
5135
	/**
5136
	 * Validate an onboarding token for a specific action
5137
	 *
5138
	 * @return boolean True if token/action pair is accepted, false if not
5139
	 */
5140
	public static function validate_onboarding_token_action( $token, $action ) {
5141
		// Compare tokens, bail if tokens do not match
5142
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5143
			return false;
5144
		}
5145
5146
		// List of valid actions we can take
5147
		$valid_actions = array(
5148
			'/jetpack/v4/settings',
5149
		);
5150
5151
		// Only allow valid actions.
5152
		if ( ! in_array( $action, $valid_actions ) ) {
5153
			return false;
5154
		}
5155
5156
		return true;
5157
	}
5158
5159
	/**
5160
	 * Checks to see if the URL is using SSL to connect with Jetpack
5161
	 *
5162
	 * @since 2.3.3
5163
	 * @return boolean
5164
	 */
5165
	public static function permit_ssl( $force_recheck = false ) {
5166
		// Do some fancy tests to see if ssl is being supported
5167
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5168
			$message = '';
5169
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5170
				$ssl = 0;
5171
			} else {
5172
				$ssl = 1;
5173
5174
				if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5175
					$ssl     = 0;
5176
					$message = __( 'WordPress reports no SSL support', 'jetpack' );
5177
				} else {
5178
					$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5179
					if ( is_wp_error( $response ) ) {
5180
						$ssl     = 0;
5181
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5182
					} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5183
						$ssl     = 0;
5184
						$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5185
					}
5186
				}
5187
			}
5188
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5189
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5190
		}
5191
5192
		return (bool) $ssl;
5193
	}
5194
5195
	/*
5196
	 * Displays an admin_notice, alerting the user that outbound SSL isn't working.
5197
	 */
5198
	public function alert_auto_ssl_fail() {
5199
		if ( ! current_user_can( 'manage_options' ) ) {
5200
			return;
5201
		}
5202
5203
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5204
		?>
5205
5206
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5207
			<div class="jp-banner__content">
5208
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5209
				<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>
5210
				<p>
5211
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5212
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5213
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5214
				</p>
5215
				<p>
5216
					<?php
5217
					printf(
5218
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5219
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5220
						esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5221
					);
5222
					?>
5223
				</p>
5224
			</div>
5225
		</div>
5226
		<style>
5227
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5228
		</style>
5229
		<script type="text/javascript">
5230
			jQuery( document ).ready( function( $ ) {
5231
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5232
					var $this = $( this );
5233
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5234
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5235
					e.preventDefault();
5236
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5237
					$.post( ajaxurl, data )
5238
					  .done( function( response ) {
5239
						  if ( response.enabled ) {
5240
							  $( '#jetpack-ssl-warning' ).hide();
5241
						  } else {
5242
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5243
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5244
						  }
5245
					  }.bind( $this ) );
5246
				} );
5247
			} );
5248
		</script>
5249
5250
		<?php
5251
	}
5252
5253
	/**
5254
	 * Returns the Jetpack XML-RPC API
5255
	 *
5256
	 * @deprecated 8.0 Use Connection_Manager instead.
5257
	 * @return string
5258
	 */
5259
	public static function xmlrpc_api_url() {
5260
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5261
		return self::connection()->xmlrpc_api_url();
5262
	}
5263
5264
	/**
5265
	 * Returns the connection manager object.
5266
	 *
5267
	 * @return Automattic\Jetpack\Connection\Manager
5268
	 */
5269
	public static function connection() {
5270
		$jetpack = static::init();
5271
5272
		// If the connection manager hasn't been instantiated, do that now.
5273
		if ( ! $jetpack->connection_manager ) {
5274
			$jetpack->connection_manager = new Connection_Manager( 'jetpack' );
5275
		}
5276
5277
		return $jetpack->connection_manager;
5278
	}
5279
5280
	/**
5281
	 * Creates two secret tokens and the end of life timestamp for them.
5282
	 *
5283
	 * Note these tokens are unique per call, NOT static per site for connecting.
5284
	 *
5285
	 * @since 2.6
5286
	 * @param String  $action  The action name.
5287
	 * @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...
5288
	 * @param Integer $exp     Expiration time in seconds.
5289
	 * @return array
5290
	 */
5291
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5292
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5293
	}
5294
5295
	public static function get_secrets( $action, $user_id ) {
5296
		$secrets = self::connection()->get_secrets( $action, $user_id );
5297
5298
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5299
			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...
5300
		}
5301
5302
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5303
			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...
5304
		}
5305
5306
		return $secrets;
5307
	}
5308
5309
	/**
5310
	 * @deprecated 7.5 Use Connection_Manager instead.
5311
	 *
5312
	 * @param $action
5313
	 * @param $user_id
5314
	 */
5315
	public static function delete_secrets( $action, $user_id ) {
5316
		return self::connection()->delete_secrets( $action, $user_id );
5317
	}
5318
5319
	/**
5320
	 * Builds the timeout limit for queries talking with the wpcom servers.
5321
	 *
5322
	 * Based on local php max_execution_time in php.ini
5323
	 *
5324
	 * @since 2.6
5325
	 * @return int
5326
	 * @deprecated
5327
	 **/
5328
	public function get_remote_query_timeout_limit() {
5329
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5330
		return self::get_max_execution_time();
5331
	}
5332
5333
	/**
5334
	 * Builds the timeout limit for queries talking with the wpcom servers.
5335
	 *
5336
	 * Based on local php max_execution_time in php.ini
5337
	 *
5338
	 * @since 5.4
5339
	 * @return int
5340
	 **/
5341
	public static function get_max_execution_time() {
5342
		$timeout = (int) ini_get( 'max_execution_time' );
5343
5344
		// Ensure exec time set in php.ini
5345
		if ( ! $timeout ) {
5346
			$timeout = 30;
5347
		}
5348
		return $timeout;
5349
	}
5350
5351
	/**
5352
	 * Sets a minimum request timeout, and returns the current timeout
5353
	 *
5354
	 * @since 5.4
5355
	 **/
5356 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5357
		$timeout = self::get_max_execution_time();
5358
		if ( $timeout < $min_timeout ) {
5359
			$timeout = $min_timeout;
5360
			set_time_limit( $timeout );
5361
		}
5362
		return $timeout;
5363
	}
5364
5365
	/**
5366
	 * Takes the response from the Jetpack register new site endpoint and
5367
	 * verifies it worked properly.
5368
	 *
5369
	 * @since 2.6
5370
	 * @deprecated since 7.7.0
5371
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5372
	 **/
5373
	public function validate_remote_register_response() {
5374
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5375
	}
5376
5377
	/**
5378
	 * @return bool|WP_Error
5379
	 */
5380
	public static function register() {
5381
		$tracking = new Tracking();
5382
		$tracking->record_user_event( 'jpc_register_begin' );
5383
5384
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5385
5386
		$connection   = self::connection();
5387
		$registration = $connection->register();
5388
5389
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5390
5391
		if ( ! $registration || is_wp_error( $registration ) ) {
5392
			return $registration;
5393
		}
5394
5395
		return true;
5396
	}
5397
5398
	/**
5399
	 * Filters the registration request body to include tracking properties.
5400
	 *
5401
	 * @param array $properties
5402
	 * @return array amended properties.
5403
	 */
5404 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5405
		$tracking        = new Tracking();
5406
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5407
5408
		return array_merge(
5409
			$properties,
5410
			array(
5411
				'_ui' => $tracks_identity['_ui'],
5412
				'_ut' => $tracks_identity['_ut'],
5413
			)
5414
		);
5415
	}
5416
5417
	/**
5418
	 * Filters the token request body to include tracking properties.
5419
	 *
5420
	 * @param array $properties
5421
	 * @return array amended properties.
5422
	 */
5423 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5424
		$tracking        = new Tracking();
5425
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5426
5427
		return array_merge(
5428
			$properties,
5429
			array(
5430
				'_ui' => $tracks_identity['_ui'],
5431
				'_ut' => $tracks_identity['_ut'],
5432
			)
5433
		);
5434
	}
5435
5436
	/**
5437
	 * If the db version is showing something other that what we've got now, bump it to current.
5438
	 *
5439
	 * @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...
5440
	 */
5441
	public static function maybe_set_version_option() {
5442
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5443
		if ( JETPACK__VERSION != $version ) {
5444
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5445
5446
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5447
				/** This action is documented in class.jetpack.php */
5448
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5449
			}
5450
5451
			return true;
5452
		}
5453
		return false;
5454
	}
5455
5456
	/* Client Server API */
5457
5458
	/**
5459
	 * Loads the Jetpack XML-RPC client.
5460
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5461
	 *
5462
	 * @deprecated since 7.7.0
5463
	 */
5464
	public static function load_xml_rpc_client() {
5465
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5466
	}
5467
5468
	/**
5469
	 * Resets the saved authentication state in between testing requests.
5470
	 *
5471
	 * @deprecated since 8.9.0
5472
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::reset_saved_auth_state()
5473
	 */
5474
	public function reset_saved_auth_state() {
5475
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::reset_saved_auth_state' );
5476
		Connection_Rest_Authentication::init()->reset_saved_auth_state();
5477
	}
5478
5479
	/**
5480
	 * Verifies the signature of the current request.
5481
	 *
5482
	 * @deprecated since 7.7.0
5483
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5484
	 *
5485
	 * @return false|array
5486
	 */
5487
	public function verify_xml_rpc_signature() {
5488
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5489
		return self::connection()->verify_xml_rpc_signature();
5490
	}
5491
5492
	/**
5493
	 * Verifies the signature of the current request.
5494
	 *
5495
	 * This function has side effects and should not be used. Instead,
5496
	 * use the memoized version `->verify_xml_rpc_signature()`.
5497
	 *
5498
	 * @deprecated since 7.7.0
5499
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5500
	 * @internal
5501
	 */
5502
	private function internal_verify_xml_rpc_signature() {
5503
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5504
	}
5505
5506
	/**
5507
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5508
	 *
5509
	 * @deprecated since 7.7.0
5510
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5511
	 *
5512
	 * @param \WP_User|mixed $user     User object if authenticated.
5513
	 * @param string         $username Username.
5514
	 * @param string         $password Password string.
5515
	 * @return \WP_User|mixed Authenticated user or error.
5516
	 */
5517 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5518
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5519
5520
		if ( ! $this->connection_manager ) {
5521
			$this->connection_manager = new Connection_Manager();
5522
		}
5523
5524
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5525
	}
5526
5527
	/**
5528
	 * Authenticates requests from Jetpack server to WP REST API endpoints.
5529
	 * Uses the existing XMLRPC request signing implementation.
5530
	 *
5531
	 * @deprecated since 8.9.0
5532
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authenticate()
5533
	 */
5534
	function wp_rest_authenticate( $user ) {
5535
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::wp_rest_authenticate' );
5536
		return Connection_Rest_Authentication::init()->wp_rest_authenticate( $user );
5537
	}
5538
5539
	/**
5540
	 * Report authentication status to the WP REST API.
5541
	 *
5542
	 * @deprecated since 8.9.0
5543
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
5544
	 *
5545
	 * @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...
5546
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5547
	 */
5548
	public function wp_rest_authentication_errors( $value ) {
5549
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::wp_rest_authenication_errors' );
5550
		return Connection_Rest_Authentication::init()->wp_rest_authentication_errors( $value );
5551
	}
5552
5553
	/**
5554
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5555
	 * Capture it here so we can verify the signature later.
5556
	 *
5557
	 * @deprecated since 7.7.0
5558
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5559
	 *
5560
	 * @param array $methods XMLRPC methods.
5561
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5562
	 */
5563 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5564
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5565
5566
		if ( ! $this->connection_manager ) {
5567
			$this->connection_manager = new Connection_Manager();
5568
		}
5569
5570
		return $this->connection_manager->xmlrpc_methods( $methods );
5571
	}
5572
5573
	/**
5574
	 * Register additional public XMLRPC methods.
5575
	 *
5576
	 * @deprecated since 7.7.0
5577
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5578
	 *
5579
	 * @param array $methods Public XMLRPC methods.
5580
	 * @return array Public XMLRPC methods, with the getOptions one.
5581
	 */
5582 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5583
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5584
5585
		if ( ! $this->connection_manager ) {
5586
			$this->connection_manager = new Connection_Manager();
5587
		}
5588
5589
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5590
	}
5591
5592
	/**
5593
	 * Handles a getOptions XMLRPC method call.
5594
	 *
5595
	 * @deprecated since 7.7.0
5596
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5597
	 *
5598
	 * @param array $args method call arguments.
5599
	 * @return array an amended XMLRPC server options array.
5600
	 */
5601 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5602
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5603
5604
		if ( ! $this->connection_manager ) {
5605
			$this->connection_manager = new Connection_Manager();
5606
		}
5607
5608
		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...
5609
	}
5610
5611
	/**
5612
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5613
	 *
5614
	 * @deprecated since 7.7.0
5615
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5616
	 *
5617
	 * @param array $options Standard Core options.
5618
	 * @return array Amended options.
5619
	 */
5620 View Code Duplication
	public function xmlrpc_options( $options ) {
5621
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5622
5623
		if ( ! $this->connection_manager ) {
5624
			$this->connection_manager = new Connection_Manager();
5625
		}
5626
5627
		return $this->connection_manager->xmlrpc_options( $options );
5628
	}
5629
5630
	/**
5631
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5632
	 * SET: state( $key, $value );
5633
	 * GET: $value = state( $key );
5634
	 *
5635
	 * @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...
5636
	 * @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...
5637
	 * @param bool   $restate private
5638
	 */
5639
	public static function state( $key = null, $value = null, $restate = false ) {
5640
		static $state = array();
5641
		static $path, $domain;
5642
		if ( ! isset( $path ) ) {
5643
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5644
			$admin_url = self::admin_url();
5645
			$bits      = wp_parse_url( $admin_url );
5646
5647
			if ( is_array( $bits ) ) {
5648
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5649
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5650
			} else {
5651
				$path = $domain = null;
5652
			}
5653
		}
5654
5655
		// Extract state from cookies and delete cookies
5656
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5657
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5658
			unset( $_COOKIE['jetpackState'] );
5659
			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...
5660
				if ( strlen( $v ) ) {
5661
					$state[ $k ] = $v;
5662
				}
5663
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5664
			}
5665
		}
5666
5667
		if ( $restate ) {
5668
			foreach ( $state as $k => $v ) {
5669
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5670
			}
5671
			return;
5672
		}
5673
5674
		// Get a state variable.
5675
		if ( isset( $key ) && ! isset( $value ) ) {
5676
			if ( array_key_exists( $key, $state ) ) {
5677
				return $state[ $key ];
5678
			}
5679
			return null;
5680
		}
5681
5682
		// Set a state variable.
5683
		if ( isset( $key ) && isset( $value ) ) {
5684
			if ( is_array( $value ) && isset( $value[0] ) ) {
5685
				$value = $value[0];
5686
			}
5687
			$state[ $key ] = $value;
5688
			if ( ! headers_sent() ) {
5689
				if ( self::should_set_cookie( $key ) ) {
5690
					setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5691
				}
5692
			}
5693
		}
5694
	}
5695
5696
	public static function restate() {
5697
		self::state( null, null, true );
5698
	}
5699
5700
	/**
5701
	 * Determines whether the jetpackState[$key] value should be added to the
5702
	 * cookie.
5703
	 *
5704
	 * @param string $key The state key.
5705
	 *
5706
	 * @return boolean Whether the value should be added to the cookie.
5707
	 */
5708
	public static function should_set_cookie( $key ) {
5709
		global $current_screen;
5710
		$page = isset( $current_screen->base ) ? $current_screen->base : null;
5711
5712
		if ( 'toplevel_page_jetpack' === $page && 'display_update_modal' === $key ) {
5713
			return false;
5714
		}
5715
5716
		return true;
5717
	}
5718
5719
	public static function check_privacy( $file ) {
5720
		static $is_site_publicly_accessible = null;
5721
5722
		if ( is_null( $is_site_publicly_accessible ) ) {
5723
			$is_site_publicly_accessible = false;
5724
5725
			$rpc = new Jetpack_IXR_Client();
5726
5727
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5728
			if ( $success ) {
5729
				$response = $rpc->getResponse();
5730
				if ( $response ) {
5731
					$is_site_publicly_accessible = true;
5732
				}
5733
			}
5734
5735
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5736
		}
5737
5738
		if ( $is_site_publicly_accessible ) {
5739
			return;
5740
		}
5741
5742
		$module_slug = self::get_module_slug( $file );
5743
5744
		$privacy_checks = self::state( 'privacy_checks' );
5745
		if ( ! $privacy_checks ) {
5746
			$privacy_checks = $module_slug;
5747
		} else {
5748
			$privacy_checks .= ",$module_slug";
5749
		}
5750
5751
		self::state( 'privacy_checks', $privacy_checks );
5752
	}
5753
5754
	/**
5755
	 * Helper method for multicall XMLRPC.
5756
	 *
5757
	 * @deprecated since 8.9.0
5758
	 * @see Automattic\\Jetpack\\Connection\\Xmlrpc_Async_Call::add_call()
5759
	 *
5760
	 * @param ...$args Args for the async_call.
5761
	 */
5762
	public static function xmlrpc_async_call( ...$args ) {
5763
5764
		_deprecated_function( 'Jetpack::xmlrpc_async_call', 'jetpack-8.9.0', 'Automattic\\Jetpack\\Connection\\Xmlrpc_Async_Call::add_call' );
5765
5766
		global $blog_id;
5767
		static $clients = array();
5768
5769
		$client_blog_id = is_multisite() ? $blog_id : 0;
5770
5771
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5772
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => Connection_Manager::CONNECTION_OWNER ) );
5773
			if ( function_exists( 'ignore_user_abort' ) ) {
5774
				ignore_user_abort( true );
5775
			}
5776
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5777
		}
5778
5779
		if ( ! empty( $args[0] ) ) {
5780
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5781
		} elseif ( is_multisite() ) {
5782
			foreach ( $clients as $client_blog_id => $client ) {
5783
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5784
					continue;
5785
				}
5786
5787
				$switch_success = switch_to_blog( $client_blog_id, true );
5788
				if ( ! $switch_success ) {
5789
					continue;
5790
				}
5791
5792
				flush();
5793
				$client->query();
5794
5795
				restore_current_blog();
5796
			}
5797
		} else {
5798
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5799
				flush();
5800
				$clients[0]->query();
5801
			}
5802
		}
5803
	}
5804
5805
	public static function staticize_subdomain( $url ) {
5806
5807
		// Extract hostname from URL
5808
		$host = wp_parse_url( $url, PHP_URL_HOST );
5809
5810
		// Explode hostname on '.'
5811
		$exploded_host = explode( '.', $host );
5812
5813
		// Retrieve the name and TLD
5814
		if ( count( $exploded_host ) > 1 ) {
5815
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5816
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5817
			// Rebuild domain excluding subdomains
5818
			$domain = $name . '.' . $tld;
5819
		} else {
5820
			$domain = $host;
5821
		}
5822
		// Array of Automattic domains.
5823
		$domains_allowed = array( 'wordpress.com', 'wp.com' );
5824
5825
		// Return $url if not an Automattic domain.
5826
		if ( ! in_array( $domain, $domains_allowed, true ) ) {
5827
			return $url;
5828
		}
5829
5830
		if ( is_ssl() ) {
5831
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5832
		}
5833
5834
		srand( crc32( basename( $url ) ) );
5835
		$static_counter = rand( 0, 2 );
5836
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5837
5838
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5839
	}
5840
5841
	/* JSON API Authorization */
5842
5843
	/**
5844
	 * Handles the login action for Authorizing the JSON API
5845
	 */
5846
	function login_form_json_api_authorization() {
5847
		$this->verify_json_api_authorization_request();
5848
5849
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5850
5851
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5852
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5853
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5854
	}
5855
5856
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5857
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5858
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5859
			return $url;
5860
		}
5861
5862
		$parsed_url = wp_parse_url( $url );
5863
		$url        = strtok( $url, '?' );
5864
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5865
		if ( ! empty( $parsed_url['query'] ) ) {
5866
			$url .= "&{$parsed_url['query']}";
5867
		}
5868
5869
		return $url;
5870
	}
5871
5872
	// Make sure the POSTed request is handled by the same action
5873
	function preserve_action_in_login_form_for_json_api_authorization() {
5874
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5875
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5876
	}
5877
5878
	// If someone logs in to approve API access, store the Access Code in usermeta
5879
	function store_json_api_authorization_token( $user_login, $user ) {
5880
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5881
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5882
		$token = wp_generate_password( 32, false );
5883
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5884
	}
5885
5886
	// Add public-api.wordpress.com to the safe redirect allowed list - only added when someone allows API access.
5887
	function allow_wpcom_public_api_domain( $domains ) {
5888
		$domains[] = 'public-api.wordpress.com';
5889
		return $domains;
5890
	}
5891
5892
	static function is_redirect_encoded( $redirect_url ) {
5893
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5894
	}
5895
5896
	// Add all wordpress.com environments to the safe redirect allowed list.
5897
	function allow_wpcom_environments( $domains ) {
5898
		$domains[] = 'wordpress.com';
5899
		$domains[] = 'wpcalypso.wordpress.com';
5900
		$domains[] = 'horizon.wordpress.com';
5901
		$domains[] = 'calypso.localhost';
5902
		return $domains;
5903
	}
5904
5905
	// Add the Access Code details to the public-api.wordpress.com redirect
5906
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5907
		return add_query_arg(
5908
			urlencode_deep(
5909
				array(
5910
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5911
					'jetpack-user-id' => (int) $user->ID,
5912
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5913
				)
5914
			),
5915
			$redirect_to
5916
		);
5917
	}
5918
5919
	/**
5920
	 * Verifies the request by checking the signature
5921
	 *
5922
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5923
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5924
	 *
5925
	 * @param null|array $environment
5926
	 */
5927
	function verify_json_api_authorization_request( $environment = null ) {
5928
		$environment = is_null( $environment )
5929
			? $_REQUEST
5930
			: $environment;
5931
5932
		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...
5933
		$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...
5934
		if ( ! $token || empty( $token->secret ) ) {
5935
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5936
		}
5937
5938
		$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' );
5939
5940
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5941
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5942
			/**
5943
			 * Jetpack authorisation request Error.
5944
			 *
5945
			 * @since 7.5.0
5946
			 */
5947
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5948
			$die_error = sprintf(
5949
				/* translators: %s is a URL */
5950
				__( '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' ),
5951
				Redirect::get_url( 'jetpack-support-double-encoding' )
5952
			);
5953
		}
5954
5955
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5956
5957
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5958
			$signature = $jetpack_signature->sign_request(
5959
				$environment['token'],
5960
				$environment['timestamp'],
5961
				$environment['nonce'],
5962
				'',
5963
				'GET',
5964
				$environment['jetpack_json_api_original_query'],
5965
				null,
5966
				true
5967
			);
5968
		} else {
5969
			$signature = $jetpack_signature->sign_current_request(
5970
				array(
5971
					'body'   => null,
5972
					'method' => 'GET',
5973
				)
5974
			);
5975
		}
5976
5977
		if ( ! $signature ) {
5978
			wp_die( $die_error );
5979
		} elseif ( is_wp_error( $signature ) ) {
5980
			wp_die( $die_error );
5981
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
5982
			if ( is_ssl() ) {
5983
				// 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
5984
				$signature = $jetpack_signature->sign_current_request(
5985
					array(
5986
						'scheme' => 'http',
5987
						'body'   => null,
5988
						'method' => 'GET',
5989
					)
5990
				);
5991
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5992
					wp_die( $die_error );
5993
				}
5994
			} else {
5995
				wp_die( $die_error );
5996
			}
5997
		}
5998
5999
		$timestamp = (int) $environment['timestamp'];
6000
		$nonce     = stripslashes( (string) $environment['nonce'] );
6001
6002
		if ( ! $this->connection_manager ) {
6003
			$this->connection_manager = new Connection_Manager();
6004
		}
6005
6006
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
6007
			// De-nonce the nonce, at least for 5 minutes.
6008
			// 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)
6009
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6010
			if ( $old_nonce_time < time() - 300 ) {
6011
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6012
			}
6013
		}
6014
6015
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6016
		$data_filters = array(
6017
			'state'        => 'opaque',
6018
			'client_id'    => 'int',
6019
			'client_title' => 'string',
6020
			'client_image' => 'url',
6021
		);
6022
6023
		foreach ( $data_filters as $key => $sanitation ) {
6024
			if ( ! isset( $data->$key ) ) {
6025
				wp_die( $die_error );
6026
			}
6027
6028
			switch ( $sanitation ) {
6029
				case 'int':
6030
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6031
					break;
6032
				case 'opaque':
6033
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6034
					break;
6035
				case 'string':
6036
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6037
					break;
6038
				case 'url':
6039
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6040
					break;
6041
			}
6042
		}
6043
6044
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6045
			wp_die( $die_error );
6046
		}
6047
	}
6048
6049
	function login_message_json_api_authorization( $message ) {
6050
		return '<p class="message">' . sprintf(
6051
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6052
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6053
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6054
	}
6055
6056
	/**
6057
	 * Get $content_width, but with a <s>twist</s> filter.
6058
	 */
6059
	public static function get_content_width() {
6060
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6061
			? $GLOBALS['content_width']
6062
			: false;
6063
		/**
6064
		 * Filter the Content Width value.
6065
		 *
6066
		 * @since 2.2.3
6067
		 *
6068
		 * @param string $content_width Content Width value.
6069
		 */
6070
		return apply_filters( 'jetpack_content_width', $content_width );
6071
	}
6072
6073
	/**
6074
	 * Pings the WordPress.com Mirror Site for the specified options.
6075
	 *
6076
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6077
	 *
6078
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6079
	 */
6080
	public function get_cloud_site_options( $option_names ) {
6081
		$option_names = array_filter( (array) $option_names, 'is_string' );
6082
6083
		$xml = new Jetpack_IXR_Client();
6084
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6085
		if ( $xml->isError() ) {
6086
			return array(
6087
				'error_code' => $xml->getErrorCode(),
6088
				'error_msg'  => $xml->getErrorMessage(),
6089
			);
6090
		}
6091
		$cloud_site_options = $xml->getResponse();
6092
6093
		return $cloud_site_options;
6094
	}
6095
6096
	/**
6097
	 * Checks if the site is currently in an identity crisis.
6098
	 *
6099
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6100
	 */
6101
	public static function check_identity_crisis() {
6102
		if ( ! self::is_active() || ( new Status() )->is_offline_mode() || ! self::validate_sync_error_idc_option() ) {
6103
			return false;
6104
		}
6105
6106
		return Jetpack_Options::get_option( 'sync_error_idc' );
6107
	}
6108
6109
	/**
6110
	 * Checks whether the home and siteurl specifically are allowed.
6111
	 * Written so that we don't have re-check $key and $value params every time
6112
	 * we want to check if this site is allowed, for example in footer.php
6113
	 *
6114
	 * @since  3.8.0
6115
	 * @return bool True = already allowed False = not on the allowed list.
6116
	 */
6117
	public static function is_staging_site() {
6118
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6119
		return ( new Status() )->is_staging_site();
6120
	}
6121
6122
	/**
6123
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6124
	 *
6125
	 * @since 4.4.0
6126
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6127
	 *
6128
	 * @return bool
6129
	 */
6130
	public static function validate_sync_error_idc_option() {
6131
		$is_valid = false;
6132
6133
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6134
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6135
		if ( $sync_error && self::sync_idc_optin() ) {
6136
			$local_options = self::get_sync_error_idc_option();
6137
			// Ensure all values are set.
6138
			if ( isset( $sync_error['home'] ) && isset( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6139
6140
				// If the WP.com expected home and siteurl match local home and siteurl it is not valid IDC.
6141
				if (
6142
						isset( $sync_error['wpcom_home'] ) &&
6143
						isset( $sync_error['wpcom_siteurl'] ) &&
6144
						$sync_error['wpcom_home'] === $local_options['home'] &&
6145
						$sync_error['wpcom_siteurl'] === $local_options['siteurl']
6146
				) {
6147
					$is_valid = false;
6148
					// Enable migrate_for_idc so that sync actions are accepted.
6149
					Jetpack_Options::update_option( 'migrate_for_idc', true );
6150
				} elseif ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6151
					$is_valid = true;
6152
				}
6153
			}
6154
		}
6155
6156
		/**
6157
		 * Filters whether the sync_error_idc option is valid.
6158
		 *
6159
		 * @since 4.4.0
6160
		 *
6161
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6162
		 */
6163
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6164
6165
		if ( ! $is_valid && $sync_error ) {
6166
			// Since the option exists, and did not validate, delete it
6167
			Jetpack_Options::delete_option( 'sync_error_idc' );
6168
		}
6169
6170
		return $is_valid;
6171
	}
6172
6173
	/**
6174
	 * Normalizes a url by doing three things:
6175
	 *  - Strips protocol
6176
	 *  - Strips www
6177
	 *  - Adds a trailing slash
6178
	 *
6179
	 * @since 4.4.0
6180
	 * @param string $url
6181
	 * @return WP_Error|string
6182
	 */
6183
	public static function normalize_url_protocol_agnostic( $url ) {
6184
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6185 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...
6186
			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...
6187
		}
6188
6189
		// Strip www and protocols
6190
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6191
		return $url;
6192
	}
6193
6194
	/**
6195
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6196
	 *
6197
	 * @since 4.4.0
6198
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6199
	 *
6200
	 * @param array $response
6201
	 * @return array Array of the local urls, wpcom urls, and error code
6202
	 */
6203
	public static function get_sync_error_idc_option( $response = array() ) {
6204
		// Since the local options will hit the database directly, store the values
6205
		// in a transient to allow for autoloading and caching on subsequent views.
6206
		$local_options = get_transient( 'jetpack_idc_local' );
6207
		if ( false === $local_options ) {
6208
			$local_options = array(
6209
				'home'    => Functions::home_url(),
6210
				'siteurl' => Functions::site_url(),
6211
			);
6212
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6213
		}
6214
6215
		$options = array_merge( $local_options, $response );
6216
6217
		$returned_values = array();
6218
		foreach ( $options as $key => $option ) {
6219
			if ( 'error_code' === $key ) {
6220
				$returned_values[ $key ] = $option;
6221
				continue;
6222
			}
6223
6224
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6225
				continue;
6226
			}
6227
6228
			$returned_values[ $key ] = $normalized_url;
6229
		}
6230
6231
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6232
6233
		return $returned_values;
6234
	}
6235
6236
	/**
6237
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6238
	 * If set to true, the site will be put into staging mode.
6239
	 *
6240
	 * @since 4.3.2
6241
	 * @return bool
6242
	 */
6243
	public static function sync_idc_optin() {
6244
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6245
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6246
		} else {
6247
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6248
		}
6249
6250
		/**
6251
		 * Allows sites to opt in for IDC mitigation which blocks the site from syncing to WordPress.com when the home
6252
		 * URL or site URL do not match what WordPress.com expects. The default value is either true, or the value of
6253
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6254
		 *
6255
		 * @since 4.3.2
6256
		 *
6257
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6258
		 */
6259
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6260
	}
6261
6262
	/**
6263
	 * Maybe Use a .min.css stylesheet, maybe not.
6264
	 *
6265
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6266
	 */
6267
	public static function maybe_min_asset( $url, $path, $plugin ) {
6268
		// Short out on things trying to find actual paths.
6269
		if ( ! $path || empty( $plugin ) ) {
6270
			return $url;
6271
		}
6272
6273
		$path = ltrim( $path, '/' );
6274
6275
		// Strip out the abspath.
6276
		$base = dirname( plugin_basename( $plugin ) );
6277
6278
		// Short out on non-Jetpack assets.
6279
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6280
			return $url;
6281
		}
6282
6283
		// File name parsing.
6284
		$file              = "{$base}/{$path}";
6285
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6286
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6287
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6288
		$extension         = array_shift( $file_name_parts_r );
6289
6290
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6291
			// Already pointing at the minified version.
6292
			if ( 'min' === $file_name_parts_r[0] ) {
6293
				return $url;
6294
			}
6295
6296
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6297
			if ( file_exists( $min_full_path ) ) {
6298
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6299
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6300
				if ( 'css' === $extension ) {
6301
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6302
					self::$min_assets[ $key ] = $path;
6303
				}
6304
			}
6305
		}
6306
6307
		return $url;
6308
	}
6309
6310
	/**
6311
	 * If the asset is minified, let's flag .min as the suffix.
6312
	 *
6313
	 * Attached to `style_loader_src` filter.
6314
	 *
6315
	 * @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...
6316
	 * @param string $handle The registered handle of the script in question.
6317
	 * @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...
6318
	 */
6319
	public static function set_suffix_on_min( $src, $handle ) {
6320
		if ( false === strpos( $src, '.min.css' ) ) {
6321
			return $src;
6322
		}
6323
6324
		if ( ! empty( self::$min_assets ) ) {
6325
			foreach ( self::$min_assets as $file => $path ) {
6326
				if ( false !== strpos( $src, $file ) ) {
6327
					wp_style_add_data( $handle, 'suffix', '.min' );
6328
					return $src;
6329
				}
6330
			}
6331
		}
6332
6333
		return $src;
6334
	}
6335
6336
	/**
6337
	 * Maybe inlines a stylesheet.
6338
	 *
6339
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6340
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6341
	 *
6342
	 * Attached to `style_loader_tag` filter.
6343
	 *
6344
	 * @param string $tag The tag that would link to the external asset.
6345
	 * @param string $handle The registered handle of the script in question.
6346
	 *
6347
	 * @return string
6348
	 */
6349
	public static function maybe_inline_style( $tag, $handle ) {
6350
		global $wp_styles;
6351
		$item = $wp_styles->registered[ $handle ];
6352
6353
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6354
			return $tag;
6355
		}
6356
6357
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6358
			$href = $matches[1];
6359
			// Strip off query string
6360
			if ( $pos = strpos( $href, '?' ) ) {
6361
				$href = substr( $href, 0, $pos );
6362
			}
6363
			// Strip off fragment
6364
			if ( $pos = strpos( $href, '#' ) ) {
6365
				$href = substr( $href, 0, $pos );
6366
			}
6367
		} else {
6368
			return $tag;
6369
		}
6370
6371
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6372
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6373
			return $tag;
6374
		}
6375
6376
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6377
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6378
			// And this isn't the pass that actually deals with the RTL version...
6379
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6380
				// Short out, as the RTL version will deal with it in a moment.
6381
				return $tag;
6382
			}
6383
		}
6384
6385
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6386
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6387
		if ( $css ) {
6388
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6389
			if ( empty( $item->extra['after'] ) ) {
6390
				wp_add_inline_style( $handle, $css );
6391
			} else {
6392
				array_unshift( $item->extra['after'], $css );
6393
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6394
			}
6395
		}
6396
6397
		return $tag;
6398
	}
6399
6400
	/**
6401
	 * Loads a view file from the views
6402
	 *
6403
	 * Data passed in with the $data parameter will be available in the
6404
	 * template file as $data['value']
6405
	 *
6406
	 * @param string $template - Template file to load
6407
	 * @param array  $data - Any data to pass along to the template
6408
	 * @return boolean - If template file was found
6409
	 **/
6410
	public function load_view( $template, $data = array() ) {
6411
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6412
6413
		if ( file_exists( $views_dir . $template ) ) {
6414
			require_once $views_dir . $template;
6415
			return true;
6416
		}
6417
6418
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6419
		return false;
6420
	}
6421
6422
	/**
6423
	 * Throws warnings for deprecated hooks to be removed from Jetpack that cannot remain in the original place in the code.
6424
	 */
6425
	public function deprecated_hooks() {
6426
		$filter_deprecated_list = array(
6427
			'jetpack_bail_on_shortcode'                    => array(
6428
				'replacement' => 'jetpack_shortcodes_to_include',
6429
				'version'     => 'jetpack-3.1.0',
6430
			),
6431
			'wpl_sharing_2014_1'                           => array(
6432
				'replacement' => null,
6433
				'version'     => 'jetpack-3.6.0',
6434
			),
6435
			'jetpack-tools-to-include'                     => array(
6436
				'replacement' => 'jetpack_tools_to_include',
6437
				'version'     => 'jetpack-3.9.0',
6438
			),
6439
			'jetpack_identity_crisis_options_to_check'     => array(
6440
				'replacement' => null,
6441
				'version'     => 'jetpack-4.0.0',
6442
			),
6443
			'update_option_jetpack_single_user_site'       => array(
6444
				'replacement' => null,
6445
				'version'     => 'jetpack-4.3.0',
6446
			),
6447
			'audio_player_default_colors'                  => array(
6448
				'replacement' => null,
6449
				'version'     => 'jetpack-4.3.0',
6450
			),
6451
			'add_option_jetpack_featured_images_enabled'   => array(
6452
				'replacement' => null,
6453
				'version'     => 'jetpack-4.3.0',
6454
			),
6455
			'add_option_jetpack_update_details'            => array(
6456
				'replacement' => null,
6457
				'version'     => 'jetpack-4.3.0',
6458
			),
6459
			'add_option_jetpack_updates'                   => array(
6460
				'replacement' => null,
6461
				'version'     => 'jetpack-4.3.0',
6462
			),
6463
			'add_option_jetpack_network_name'              => array(
6464
				'replacement' => null,
6465
				'version'     => 'jetpack-4.3.0',
6466
			),
6467
			'add_option_jetpack_network_allow_new_registrations' => array(
6468
				'replacement' => null,
6469
				'version'     => 'jetpack-4.3.0',
6470
			),
6471
			'add_option_jetpack_network_add_new_users'     => array(
6472
				'replacement' => null,
6473
				'version'     => 'jetpack-4.3.0',
6474
			),
6475
			'add_option_jetpack_network_site_upload_space' => array(
6476
				'replacement' => null,
6477
				'version'     => 'jetpack-4.3.0',
6478
			),
6479
			'add_option_jetpack_network_upload_file_types' => array(
6480
				'replacement' => null,
6481
				'version'     => 'jetpack-4.3.0',
6482
			),
6483
			'add_option_jetpack_network_enable_administration_menus' => array(
6484
				'replacement' => null,
6485
				'version'     => 'jetpack-4.3.0',
6486
			),
6487
			'add_option_jetpack_is_multi_site'             => array(
6488
				'replacement' => null,
6489
				'version'     => 'jetpack-4.3.0',
6490
			),
6491
			'add_option_jetpack_is_main_network'           => array(
6492
				'replacement' => null,
6493
				'version'     => 'jetpack-4.3.0',
6494
			),
6495
			'add_option_jetpack_main_network_site'         => array(
6496
				'replacement' => null,
6497
				'version'     => 'jetpack-4.3.0',
6498
			),
6499
			'jetpack_sync_all_registered_options'          => array(
6500
				'replacement' => null,
6501
				'version'     => 'jetpack-4.3.0',
6502
			),
6503
			'jetpack_has_identity_crisis'                  => array(
6504
				'replacement' => 'jetpack_sync_error_idc_validation',
6505
				'version'     => 'jetpack-4.4.0',
6506
			),
6507
			'jetpack_is_post_mailable'                     => array(
6508
				'replacement' => null,
6509
				'version'     => 'jetpack-4.4.0',
6510
			),
6511
			'jetpack_seo_site_host'                        => array(
6512
				'replacement' => null,
6513
				'version'     => 'jetpack-5.1.0',
6514
			),
6515
			'jetpack_installed_plugin'                     => array(
6516
				'replacement' => 'jetpack_plugin_installed',
6517
				'version'     => 'jetpack-6.0.0',
6518
			),
6519
			'jetpack_holiday_snow_option_name'             => array(
6520
				'replacement' => null,
6521
				'version'     => 'jetpack-6.0.0',
6522
			),
6523
			'jetpack_holiday_chance_of_snow'               => array(
6524
				'replacement' => null,
6525
				'version'     => 'jetpack-6.0.0',
6526
			),
6527
			'jetpack_holiday_snow_js_url'                  => array(
6528
				'replacement' => null,
6529
				'version'     => 'jetpack-6.0.0',
6530
			),
6531
			'jetpack_is_holiday_snow_season'               => array(
6532
				'replacement' => null,
6533
				'version'     => 'jetpack-6.0.0',
6534
			),
6535
			'jetpack_holiday_snow_option_updated'          => array(
6536
				'replacement' => null,
6537
				'version'     => 'jetpack-6.0.0',
6538
			),
6539
			'jetpack_holiday_snowing'                      => array(
6540
				'replacement' => null,
6541
				'version'     => 'jetpack-6.0.0',
6542
			),
6543
			'jetpack_sso_auth_cookie_expirtation'          => array(
6544
				'replacement' => 'jetpack_sso_auth_cookie_expiration',
6545
				'version'     => 'jetpack-6.1.0',
6546
			),
6547
			'jetpack_cache_plans'                          => array(
6548
				'replacement' => null,
6549
				'version'     => 'jetpack-6.1.0',
6550
			),
6551
6552
			'jetpack_lazy_images_skip_image_with_atttributes' => array(
6553
				'replacement' => 'jetpack_lazy_images_skip_image_with_attributes',
6554
				'version'     => 'jetpack-6.5.0',
6555
			),
6556
			'jetpack_enable_site_verification'             => array(
6557
				'replacement' => null,
6558
				'version'     => 'jetpack-6.5.0',
6559
			),
6560
			'can_display_jetpack_manage_notice'            => array(
6561
				'replacement' => null,
6562
				'version'     => 'jetpack-7.3.0',
6563
			),
6564
			'atd_http_post_timeout'                        => array(
6565
				'replacement' => null,
6566
				'version'     => 'jetpack-7.3.0',
6567
			),
6568
			'atd_service_domain'                           => array(
6569
				'replacement' => null,
6570
				'version'     => 'jetpack-7.3.0',
6571
			),
6572
			'atd_load_scripts'                             => array(
6573
				'replacement' => null,
6574
				'version'     => 'jetpack-7.3.0',
6575
			),
6576
			'jetpack_widget_authors_exclude'               => array(
6577
				'replacement' => 'jetpack_widget_authors_params',
6578
				'version'     => 'jetpack-7.7.0',
6579
			),
6580
			// Removed in Jetpack 7.9.0
6581
			'jetpack_pwa_manifest'                         => array(
6582
				'replacement' => null,
6583
				'version'     => 'jetpack-7.9.0',
6584
			),
6585
			'jetpack_pwa_background_color'                 => array(
6586
				'replacement' => null,
6587
				'version'     => 'jetpack-7.9.0',
6588
			),
6589
			'jetpack_check_mobile'                         => array(
6590
				'replacement' => null,
6591
				'version'     => 'jetpack-8.3.0',
6592
			),
6593
			'jetpack_mobile_stylesheet'                    => array(
6594
				'replacement' => null,
6595
				'version'     => 'jetpack-8.3.0',
6596
			),
6597
			'jetpack_mobile_template'                      => array(
6598
				'replacement' => null,
6599
				'version'     => 'jetpack-8.3.0',
6600
			),
6601
			'jetpack_mobile_theme_menu'                    => array(
6602
				'replacement' => null,
6603
				'version'     => 'jetpack-8.3.0',
6604
			),
6605
			'minileven_show_featured_images'               => array(
6606
				'replacement' => null,
6607
				'version'     => 'jetpack-8.3.0',
6608
			),
6609
			'minileven_attachment_size'                    => array(
6610
				'replacement' => null,
6611
				'version'     => 'jetpack-8.3.0',
6612
			),
6613
			'instagram_cache_oembed_api_response_body'     => array(
6614
				'replacement' => null,
6615
				'version'     => 'jetpack-9.1.0',
6616
			),
6617
			'jetpack_can_make_outbound_https'              => array(
6618
				'replacement' => null,
6619
				'version'     => 'jetpack-9.1.0',
6620
			),
6621
		);
6622
6623
		foreach ( $filter_deprecated_list as $tag => $args ) {
6624
			if ( has_filter( $tag ) ) {
6625
				apply_filters_deprecated( $tag, array( null ), $args['version'], $args['replacement'] );
6626
			}
6627
		}
6628
6629
		$action_deprecated_list = array(
6630
			'jetpack_updated_theme'        => array(
6631
				'replacement' => 'jetpack_updated_themes',
6632
				'version'     => 'jetpack-6.2.0',
6633
			),
6634
			'atd_http_post_error'          => array(
6635
				'replacement' => null,
6636
				'version'     => 'jetpack-7.3.0',
6637
			),
6638
			'mobile_reject_mobile'         => array(
6639
				'replacement' => null,
6640
				'version'     => 'jetpack-8.3.0',
6641
			),
6642
			'mobile_force_mobile'          => array(
6643
				'replacement' => null,
6644
				'version'     => 'jetpack-8.3.0',
6645
			),
6646
			'mobile_app_promo_download'    => array(
6647
				'replacement' => null,
6648
				'version'     => 'jetpack-8.3.0',
6649
			),
6650
			'mobile_setup'                 => array(
6651
				'replacement' => null,
6652
				'version'     => 'jetpack-8.3.0',
6653
			),
6654
			'jetpack_mobile_footer_before' => array(
6655
				'replacement' => null,
6656
				'version'     => 'jetpack-8.3.0',
6657
			),
6658
			'wp_mobile_theme_footer'       => array(
6659
				'replacement' => null,
6660
				'version'     => 'jetpack-8.3.0',
6661
			),
6662
			'minileven_credits'            => array(
6663
				'replacement' => null,
6664
				'version'     => 'jetpack-8.3.0',
6665
			),
6666
			'jetpack_mobile_header_before' => array(
6667
				'replacement' => null,
6668
				'version'     => 'jetpack-8.3.0',
6669
			),
6670
			'jetpack_mobile_header_after'  => array(
6671
				'replacement' => null,
6672
				'version'     => 'jetpack-8.3.0',
6673
			),
6674
		);
6675
6676
		foreach ( $action_deprecated_list as $tag => $args ) {
6677
			if ( has_action( $tag ) ) {
6678
				do_action_deprecated( $tag, array(), $args['version'], $args['replacement'] );
6679
			}
6680
		}
6681
	}
6682
6683
	/**
6684
	 * Converts any url in a stylesheet, to the correct absolute url.
6685
	 *
6686
	 * Considerations:
6687
	 *  - Normal, relative URLs     `feh.png`
6688
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6689
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6690
	 *  - Absolute URLs             `http://domain.com/feh.png`
6691
	 *  - Domain root relative URLs `/feh.png`
6692
	 *
6693
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6694
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6695
	 *
6696
	 * @return mixed|string
6697
	 */
6698
	public static function absolutize_css_urls( $css, $css_file_url ) {
6699
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6700
		$css_dir = dirname( $css_file_url );
6701
		$p       = wp_parse_url( $css_dir );
6702
		$domain  = sprintf(
6703
			'%1$s//%2$s%3$s%4$s',
6704
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6705
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6706
			$p['host'],
6707
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6708
		);
6709
6710
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6711
			$find = $replace = array();
6712
			foreach ( $matches as $match ) {
6713
				$url = trim( $match['path'], "'\" \t" );
6714
6715
				// If this is a data url, we don't want to mess with it.
6716
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6717
					continue;
6718
				}
6719
6720
				// If this is an absolute or protocol-agnostic url,
6721
				// we don't want to mess with it.
6722
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6723
					continue;
6724
				}
6725
6726
				switch ( substr( $url, 0, 1 ) ) {
6727
					case '/':
6728
						$absolute = $domain . $url;
6729
						break;
6730
					default:
6731
						$absolute = $css_dir . '/' . $url;
6732
				}
6733
6734
				$find[]    = $match[0];
6735
				$replace[] = sprintf( 'url("%s")', $absolute );
6736
			}
6737
			$css = str_replace( $find, $replace, $css );
6738
		}
6739
6740
		return $css;
6741
	}
6742
6743
	/**
6744
	 * This methods removes all of the registered css files on the front end
6745
	 * from Jetpack in favor of using a single file. In effect "imploding"
6746
	 * all the files into one file.
6747
	 *
6748
	 * Pros:
6749
	 * - Uses only ONE css asset connection instead of 15
6750
	 * - Saves a minimum of 56k
6751
	 * - Reduces server load
6752
	 * - Reduces time to first painted byte
6753
	 *
6754
	 * Cons:
6755
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6756
	 *      should not cause any issues with themes.
6757
	 * - Plugins/themes dequeuing styles no longer do anything. See
6758
	 *      jetpack_implode_frontend_css filter for a workaround
6759
	 *
6760
	 * For some situations developers may wish to disable css imploding and
6761
	 * instead operate in legacy mode where each file loads seperately and
6762
	 * can be edited individually or dequeued. This can be accomplished with
6763
	 * the following line:
6764
	 *
6765
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6766
	 *
6767
	 * @since 3.2
6768
	 **/
6769
	public function implode_frontend_css( $travis_test = false ) {
6770
		$do_implode = true;
6771
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6772
			$do_implode = false;
6773
		}
6774
6775
		// Do not implode CSS when the page loads via the AMP plugin.
6776
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6777
			$do_implode = false;
6778
		}
6779
6780
		/**
6781
		 * Allow CSS to be concatenated into a single jetpack.css file.
6782
		 *
6783
		 * @since 3.2.0
6784
		 *
6785
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6786
		 */
6787
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6788
6789
		// Do not use the imploded file when default behavior was altered through the filter
6790
		if ( ! $do_implode ) {
6791
			return;
6792
		}
6793
6794
		// We do not want to use the imploded file in dev mode, or if not connected
6795
		if ( ( new Status() )->is_offline_mode() || ! self::is_active() ) {
6796
			if ( ! $travis_test ) {
6797
				return;
6798
			}
6799
		}
6800
6801
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6802
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6803
			return;
6804
		}
6805
6806
		/*
6807
		 * Now we assume Jetpack is connected and able to serve the single
6808
		 * file.
6809
		 *
6810
		 * In the future there will be a check here to serve the file locally
6811
		 * or potentially from the Jetpack CDN
6812
		 *
6813
		 * For now:
6814
		 * - Enqueue a single imploded css file
6815
		 * - Zero out the style_loader_tag for the bundled ones
6816
		 * - Be happy, drink scotch
6817
		 */
6818
6819
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6820
6821
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6822
6823
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6824
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6825
	}
6826
6827
	function concat_remove_style_loader_tag( $tag, $handle ) {
6828
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6829
			$tag = '';
6830
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6831
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6832
			}
6833
		}
6834
6835
		return $tag;
6836
	}
6837
6838
	/**
6839
	 * @deprecated
6840
	 * @see Automattic\Jetpack\Assets\add_aync_script
6841
	 */
6842
	public function script_add_async( $tag, $handle, $src ) {
6843
		_deprecated_function( __METHOD__, 'jetpack-8.6.0' );
6844
	}
6845
6846
	/*
6847
	 * Check the heartbeat data
6848
	 *
6849
	 * Organizes the heartbeat data by severity.  For example, if the site
6850
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6851
	 *
6852
	 * Data will be added to "caution" array, if it either:
6853
	 *  - Out of date Jetpack version
6854
	 *  - Out of date WP version
6855
	 *  - Out of date PHP version
6856
	 *
6857
	 * $return array $filtered_data
6858
	 */
6859
	public static function jetpack_check_heartbeat_data() {
6860
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6861
6862
		$good    = array();
6863
		$caution = array();
6864
		$bad     = array();
6865
6866
		foreach ( $raw_data as $stat => $value ) {
6867
6868
			// Check jetpack version
6869
			if ( 'version' == $stat ) {
6870
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6871
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6872
					continue;
6873
				}
6874
			}
6875
6876
			// Check WP version
6877
			if ( 'wp-version' == $stat ) {
6878
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6879
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6880
					continue;
6881
				}
6882
			}
6883
6884
			// Check PHP version
6885
			if ( 'php-version' == $stat ) {
6886
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6887
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_PHP_VERSION;
6888
					continue;
6889
				}
6890
			}
6891
6892
			// Check ID crisis
6893
			if ( 'identitycrisis' == $stat ) {
6894
				if ( 'yes' == $value ) {
6895
					$bad[ $stat ] = $value;
6896
					continue;
6897
				}
6898
			}
6899
6900
			// The rest are good :)
6901
			$good[ $stat ] = $value;
6902
		}
6903
6904
		$filtered_data = array(
6905
			'good'    => $good,
6906
			'caution' => $caution,
6907
			'bad'     => $bad,
6908
		);
6909
6910
		return $filtered_data;
6911
	}
6912
6913
	/*
6914
	 * This method is used to organize all options that can be reset
6915
	 * without disconnecting Jetpack.
6916
	 *
6917
	 * It is used in class.jetpack-cli.php to reset options
6918
	 *
6919
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6920
	 *
6921
	 * @return array of options to delete.
6922
	 */
6923
	public static function get_jetpack_options_for_reset() {
6924
		return Jetpack_Options::get_options_for_reset();
6925
	}
6926
6927
	/*
6928
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6929
	 * so we can bring them directly to their site in calypso.
6930
	 *
6931
	 * @deprecated 9.2.0 Use Automattic\Jetpack\Status::get_site_suffix
6932
	 *
6933
	 * @param string | url
6934
	 * @return string | url without the guff
6935
	 */
6936
	public static function build_raw_urls( $url ) {
6937
		_deprecated_function( __METHOD__, 'jetpack-9.2.0', 'Automattic\Jetpack\Status::get_site_suffix' );
6938
6939
		return ( new Status() )->get_site_suffix( $url );
6940
	}
6941
6942
	/**
6943
	 * Stores and prints out domains to prefetch for page speed optimization.
6944
	 *
6945
	 * @deprecated 8.8.0 Use Jetpack::add_resource_hints.
6946
	 *
6947
	 * @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...
6948
	 */
6949
	public static function dns_prefetch( $urls = null ) {
6950
		_deprecated_function( __FUNCTION__, 'jetpack-8.8.0', 'Automattic\Jetpack\Assets::add_resource_hint' );
6951
		if ( $urls ) {
6952
			Assets::add_resource_hint( $urls );
6953
		}
6954
	}
6955
6956
	public function wp_dashboard_setup() {
6957
		if ( self::is_active() ) {
6958
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6959
		}
6960
6961
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6962
			$jetpack_logo = new Jetpack_Logo();
6963
			$widget_title = sprintf(
6964
				wp_kses(
6965
					/* translators: Placeholder is a Jetpack logo. */
6966
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6967
					array( 'span' => array() )
6968
				),
6969
				$jetpack_logo->get_jp_emblem( true )
6970
			);
6971
6972
			wp_add_dashboard_widget(
6973
				'jetpack_summary_widget',
6974
				$widget_title,
6975
				array( __CLASS__, 'dashboard_widget' )
6976
			);
6977
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6978
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6979
6980
			// If we're inactive and not in offline mode, sort our box to the top.
6981
			if ( ! self::is_active() && ! ( new Status() )->is_offline_mode() ) {
6982
				global $wp_meta_boxes;
6983
6984
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6985
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6986
6987
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6988
			}
6989
		}
6990
	}
6991
6992
	/**
6993
	 * @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...
6994
	 * @return mixed
6995
	 */
6996
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6997
		if ( ! is_array( $sorted ) ) {
6998
			return $sorted;
6999
		}
7000
7001
		foreach ( $sorted as $box_context => $ids ) {
7002
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
7003
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
7004
				continue;
7005
			}
7006
7007
			$ids_array = explode( ',', $ids );
7008
			$key       = array_search( 'dashboard_stats', $ids_array );
7009
7010
			if ( false !== $key ) {
7011
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7012
				$ids_array[ $key ]      = 'jetpack_summary_widget';
7013
				$sorted[ $box_context ] = implode( ',', $ids_array );
7014
				// We've found it, stop searching, and just return.
7015
				break;
7016
			}
7017
		}
7018
7019
		return $sorted;
7020
	}
7021
7022
	public static function dashboard_widget() {
7023
		/**
7024
		 * Fires when the dashboard is loaded.
7025
		 *
7026
		 * @since 3.4.0
7027
		 */
7028
		do_action( 'jetpack_dashboard_widget' );
7029
	}
7030
7031
	public static function dashboard_widget_footer() {
7032
		?>
7033
		<footer>
7034
7035
		<div class="protect">
7036
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
7037
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
7038
				<p class="blocked-count">
7039
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
7040
				</p>
7041
				<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>
7042
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_offline_mode() ) : ?>
7043
				<a href="
7044
				<?php
7045
				echo esc_url(
7046
					wp_nonce_url(
7047
						self::admin_url(
7048
							array(
7049
								'action' => 'activate',
7050
								'module' => 'protect',
7051
							)
7052
						),
7053
						'jetpack_activate-protect'
7054
					)
7055
				);
7056
				?>
7057
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
7058
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
7059
				</a>
7060
			<?php else : ?>
7061
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
7062
			<?php endif; ?>
7063
		</div>
7064
7065
		<div class="akismet">
7066
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
7067
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7068
				<p class="blocked-count">
7069
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
7070
				</p>
7071
				<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>
7072
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7073
				<a href="
7074
				<?php
7075
				echo esc_url(
7076
					wp_nonce_url(
7077
						add_query_arg(
7078
							array(
7079
								'action' => 'activate',
7080
								'plugin' => 'akismet/akismet.php',
7081
							),
7082
							admin_url( 'plugins.php' )
7083
						),
7084
						'activate-plugin_akismet/akismet.php'
7085
					)
7086
				);
7087
				?>
7088
							" class="button button-jetpack">
7089
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
7090
				</a>
7091
			<?php else : ?>
7092
				<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>
7093
			<?php endif; ?>
7094
		</div>
7095
7096
		</footer>
7097
		<?php
7098
	}
7099
7100
	/*
7101
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7102
	 */
7103
	function jetpack_icon_user_connected( $columns ) {
7104
		$columns['user_jetpack'] = '';
7105
		return $columns;
7106
	}
7107
7108
	/*
7109
	 * Show Jetpack icon if the user is linked.
7110
	 */
7111
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7112
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
7113
			$jetpack_logo = new Jetpack_Logo();
7114
			$emblem_html  = sprintf(
7115
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7116
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7117
				$jetpack_logo->get_jp_emblem()
7118
			);
7119
			return $emblem_html;
7120
		}
7121
7122
		return $val;
7123
	}
7124
7125
	/*
7126
	 * Style the Jetpack user column
7127
	 */
7128
	function jetpack_user_col_style() {
7129
		global $current_screen;
7130
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7131
			?>
7132
			<style>
7133
				.fixed .column-user_jetpack {
7134
					width: 21px;
7135
				}
7136
				.jp-emblem-user-admin svg {
7137
					width: 20px;
7138
					height: 20px;
7139
				}
7140
				.jp-emblem-user-admin path {
7141
					fill: #00BE28;
7142
				}
7143
			</style>
7144
			<?php
7145
		}
7146
	}
7147
7148
	/**
7149
	 * Checks if Akismet is active and working.
7150
	 *
7151
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7152
	 * that implied usage of methods present since more recent version.
7153
	 * See https://github.com/Automattic/jetpack/pull/9585
7154
	 *
7155
	 * @since  5.1.0
7156
	 *
7157
	 * @return bool True = Akismet available. False = Aksimet not available.
7158
	 */
7159
	public static function is_akismet_active() {
7160
		static $status = null;
7161
7162
		if ( ! is_null( $status ) ) {
7163
			return $status;
7164
		}
7165
7166
		// Check if a modern version of Akismet is active.
7167
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7168
			$status = false;
7169
			return $status;
7170
		}
7171
7172
		// Make sure there is a key known to Akismet at all before verifying key.
7173
		$akismet_key = Akismet::get_api_key();
7174
		if ( ! $akismet_key ) {
7175
			$status = false;
7176
			return $status;
7177
		}
7178
7179
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7180
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7181
7182
		// 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.
7183
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7184
		// We cache the result of the Akismet key verification for ten minutes.
7185
		if ( ! $akismet_key_state || $recheck ) {
7186
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7187
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7188
		}
7189
7190
		$status = 'valid' === $akismet_key_state;
7191
7192
		return $status;
7193
	}
7194
7195
	/**
7196
	 * @deprecated
7197
	 *
7198
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7199
	 */
7200
	public static function is_function_in_backtrace() {
7201
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7202
	}
7203
7204
	/**
7205
	 * Given a minified path, and a non-minified path, will return
7206
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7207
	 *
7208
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7209
	 * root Jetpack directory.
7210
	 *
7211
	 * @since 5.6.0
7212
	 *
7213
	 * @param string $min_path
7214
	 * @param string $non_min_path
7215
	 * @return string The URL to the file
7216
	 */
7217
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7218
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7219
	}
7220
7221
	/**
7222
	 * Checks for whether Jetpack Backup is enabled.
7223
	 * Will return true if the state of Backup is anything except "unavailable".
7224
	 *
7225
	 * @return bool|int|mixed
7226
	 */
7227
	public static function is_rewind_enabled() {
7228
		if ( ! self::is_active() ) {
7229
			return false;
7230
		}
7231
7232
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7233
		if ( false === $rewind_enabled ) {
7234
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7235
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7236
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7237
				&& ! empty( $rewind_data['state'] )
7238
				&& 'active' === $rewind_data['state'] )
7239
				? 1
7240
				: 0;
7241
7242
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7243
		}
7244
		return $rewind_enabled;
7245
	}
7246
7247
	/**
7248
	 * Return Calypso environment value; used for developing Jetpack and pairing
7249
	 * it with different Calypso enrionments, such as localhost.
7250
	 *
7251
	 * @since 7.4.0
7252
	 *
7253
	 * @return string Calypso environment
7254
	 */
7255
	public static function get_calypso_env() {
7256
		if ( isset( $_GET['calypso_env'] ) ) {
7257
			return sanitize_key( $_GET['calypso_env'] );
7258
		}
7259
7260
		if ( getenv( 'CALYPSO_ENV' ) ) {
7261
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7262
		}
7263
7264
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7265
			return sanitize_key( CALYPSO_ENV );
7266
		}
7267
7268
		return '';
7269
	}
7270
7271
	/**
7272
	 * Returns the hostname with protocol for Calypso.
7273
	 * Used for developing Jetpack with Calypso.
7274
	 *
7275
	 * @since 8.4.0
7276
	 *
7277
	 * @return string Calypso host.
7278
	 */
7279
	public static function get_calypso_host() {
7280
		$calypso_env = self::get_calypso_env();
7281
		switch ( $calypso_env ) {
7282
			case 'development':
7283
				return 'http://calypso.localhost:3000/';
7284
			case 'wpcalypso':
7285
				return 'https://wpcalypso.wordpress.com/';
7286
			case 'horizon':
7287
				return 'https://horizon.wordpress.com/';
7288
			default:
7289
				return 'https://wordpress.com/';
7290
		}
7291
	}
7292
7293
	/**
7294
	 * Handles activating default modules as well general cleanup for the new connection.
7295
	 *
7296
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7297
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7298
	 * @param boolean $send_state_messages          Whether to send state messages.
7299
	 * @return void
7300
	 */
7301
	public static function handle_post_authorization_actions(
7302
		$activate_sso = false,
7303
		$redirect_on_activation_error = false,
7304
		$send_state_messages = true
7305
	) {
7306
		$other_modules = $activate_sso
7307
			? array( 'sso' )
7308
			: array();
7309
7310
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7311
			self::delete_active_modules();
7312
7313
			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...
7314
		} else {
7315
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7316
		}
7317
7318
		// Since this is a fresh connection, be sure to clear out IDC options
7319
		Jetpack_IDC::clear_all_idc_options();
7320
7321
		if ( $send_state_messages ) {
7322
			self::state( 'message', 'authorized' );
7323
		}
7324
	}
7325
7326
	/**
7327
	 * Returns a boolean for whether backups UI should be displayed or not.
7328
	 *
7329
	 * @return bool Should backups UI be displayed?
7330
	 */
7331
	public static function show_backups_ui() {
7332
		/**
7333
		 * Whether UI for backups should be displayed.
7334
		 *
7335
		 * @since 6.5.0
7336
		 *
7337
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7338
		 */
7339
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7340
	}
7341
7342
	/*
7343
	 * Deprecated manage functions
7344
	 */
7345
	function prepare_manage_jetpack_notice() {
7346
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7347
	}
7348
	function manage_activate_screen() {
7349
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7350
	}
7351
	function admin_jetpack_manage_notice() {
7352
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7353
	}
7354
	function opt_out_jetpack_manage_url() {
7355
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7356
	}
7357
	function opt_in_jetpack_manage_url() {
7358
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7359
	}
7360
	function opt_in_jetpack_manage_notice() {
7361
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7362
	}
7363
	function can_display_jetpack_manage_notice() {
7364
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7365
	}
7366
7367
	/**
7368
	 * Clean leftoveruser meta.
7369
	 *
7370
	 * Delete Jetpack-related user meta when it is no longer needed.
7371
	 *
7372
	 * @since 7.3.0
7373
	 *
7374
	 * @param int $user_id User ID being updated.
7375
	 */
7376
	public static function user_meta_cleanup( $user_id ) {
7377
		$meta_keys = array(
7378
			// AtD removed from Jetpack 7.3
7379
			'AtD_options',
7380
			'AtD_check_when',
7381
			'AtD_guess_lang',
7382
			'AtD_ignored_phrases',
7383
		);
7384
7385
		foreach ( $meta_keys as $meta_key ) {
7386
			if ( get_user_meta( $user_id, $meta_key ) ) {
7387
				delete_user_meta( $user_id, $meta_key );
7388
			}
7389
		}
7390
	}
7391
7392
	/**
7393
	 * Checks if a Jetpack site is both active and not in offline mode.
7394
	 *
7395
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_offline_mode`.
7396
	 *
7397
	 * @deprecated 8.8.0
7398
	 *
7399
	 * @return bool True if Jetpack is active and not in offline mode.
7400
	 */
7401
	public static function is_active_and_not_development_mode() {
7402
		_deprecated_function( __FUNCTION__, 'jetpack-8.8.0', 'Jetpack::is_active_and_not_offline_mode' );
7403
		if ( ! self::is_active() || ( new Status() )->is_offline_mode() ) {
7404
			return false;
7405
		}
7406
		return true;
7407
	}
7408
7409
	/**
7410
	 * Checks if a Jetpack site is both active and not in offline mode.
7411
	 *
7412
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_offline_mode`.
7413
	 *
7414
	 * @since 8.8.0
7415
	 *
7416
	 * @return bool True if Jetpack is active and not in offline mode.
7417
	 */
7418
	public static function is_active_and_not_offline_mode() {
7419
		if ( ! self::is_active() || ( new Status() )->is_offline_mode() ) {
7420
			return false;
7421
		}
7422
		return true;
7423
	}
7424
7425
	/**
7426
	 * Returns the list of products that we have available for purchase.
7427
	 */
7428
	public static function get_products_for_purchase() {
7429
		$products = array();
7430
		if ( ! is_multisite() ) {
7431
			$products[] = array(
7432
				'key'               => 'backup',
7433
				'title'             => __( 'Jetpack Backup', 'jetpack' ),
7434
				'short_description' => __( 'Always-on backups ensure you never lose your site.', 'jetpack' ),
7435
				'learn_more'        => __( 'Which backup option is best for me?', 'jetpack' ),
7436
				'description'       => __( 'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.', 'jetpack' ),
7437
				'options_label'     => __( 'Select a backup option:', 'jetpack' ),
7438
				'options'           => array(
7439
					array(
7440
						'type'        => 'daily',
7441
						'slug'        => 'jetpack-backup-daily',
7442
						'key'         => 'jetpack_backup_daily',
7443
						'name'        => __( 'Daily Backups', 'jetpack' ),
7444
						'description' => __( 'Your data is being securely backed up daily.', 'jetpack' ),
7445
					),
7446
					array(
7447
						'type'        => 'realtime',
7448
						'slug'        => 'jetpack-backup-realtime',
7449
						'key'         => 'jetpack_backup_realtime',
7450
						'name'        => __( 'Real-Time Backups', 'jetpack' ),
7451
						'description' => __( 'Your data is being securely backed up as you edit.', 'jetpack' ),
7452
					),
7453
				),
7454
				'default_option'    => 'realtime',
7455
				'show_promotion'    => true,
7456
				'discount_percent'  => 70,
7457
				'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'daily-backup-plan', 'realtime-backup-plan' ),
7458
			);
7459
7460
			$products[] = array(
7461
				'key'               => 'scan',
7462
				'title'             => __( 'Jetpack Scan', 'jetpack' ),
7463
				'short_description' => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7464
				'learn_more'        => __( 'Learn More', 'jetpack' ),
7465
				'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7466
				'show_promotion'    => true,
7467
				'discount_percent'  => 30,
7468
				'options'           => array(
7469
					array(
7470
						'type' => 'scan',
7471
						'slug' => 'jetpack-scan',
7472
						'key'  => 'jetpack_scan',
7473
						'name' => __( 'Daily Scan', 'jetpack' ),
7474
					),
7475
				),
7476
				'default_option'    => 'scan',
7477
				'included_in_plans' => array( 'premium-plan', 'business-plan', 'scan-plan' ),
7478
			);
7479
		}
7480
7481
		$products[] = array(
7482
			'key'               => 'search',
7483
			'title'             => __( 'Jetpack Search', 'jetpack' ),
7484
			'short_description' => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7485
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7486
			'description'       => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7487
			'label_popup'       => __( 'Records are all posts, pages, custom post types, and other types of content indexed by Jetpack Search.', 'jetpack' ),
7488
			'options'           => array(
7489
				array(
7490
					'type' => 'search',
7491
					'slug' => 'jetpack-search',
7492
					'key'  => 'jetpack_search',
7493
					'name' => __( 'Search', 'jetpack' ),
7494
				),
7495
			),
7496
			'tears'             => array(),
7497
			'default_option'    => 'search',
7498
			'show_promotion'    => false,
7499
			'included_in_plans' => array( 'search-plan' ),
7500
		);
7501
7502
		$products[] = array(
7503
			'key'               => 'anti-spam',
7504
			'title'             => __( 'Jetpack Anti-Spam', 'jetpack' ),
7505
			'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' ),
7506
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7507
			'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' ),
7508
			'options'           => array(
7509
				array(
7510
					'type' => 'anti-spam',
7511
					'slug' => 'jetpack-anti-spam',
7512
					'key'  => 'jetpack_anti_spam',
7513
					'name' => __( 'Anti-Spam', 'jetpack' ),
7514
				),
7515
			),
7516
			'default_option'    => 'anti-spam',
7517
			'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'anti-spam-plan' ),
7518
		);
7519
7520
		return $products;
7521
	}
7522
}
7523