Completed
Push — try/e2e-stablility ( 9da2c1...b192ec )
by Yaroslav
256:28 queued 245:59
created

Jetpack::can_display_jetpack_manage_notice()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
<?php
2
3
use Automattic\Jetpack\Assets;
4
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
5
use Automattic\Jetpack\Config;
6
use Automattic\Jetpack\Connection\Client;
7
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
8
use Automattic\Jetpack\Connection\Nonce_Handler;
9
use Automattic\Jetpack\Connection\Plugin_Storage as Connection_Plugin_Storage;
10
use Automattic\Jetpack\Connection\Rest_Authentication as Connection_Rest_Authentication;
11
use Automattic\Jetpack\Connection\Secrets;
12
use Automattic\Jetpack\Connection\Tokens;
13
use Automattic\Jetpack\Connection\Webhooks as Connection_Webhooks;
14
use Automattic\Jetpack\Constants;
15
use Automattic\Jetpack\Device_Detection\User_Agent_Info;
16
use Automattic\Jetpack\Licensing;
17
use Automattic\Jetpack\Partner;
18
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
19
use Automattic\Jetpack\Redirect;
20
use Automattic\Jetpack\Status;
21
use Automattic\Jetpack\Sync\Functions;
22
use Automattic\Jetpack\Sync\Health;
23
use Automattic\Jetpack\Sync\Sender;
24
use Automattic\Jetpack\Sync\Users;
25
use Automattic\Jetpack\Terms_Of_Service;
26
use Automattic\Jetpack\Tracking;
27
28
/*
29
Options:
30
jetpack_options (array)
31
	An array of options.
32
	@see Jetpack_Options::get_option_names()
33
34
jetpack_register (string)
35
	Temporary verification secrets.
36
37
jetpack_activated (int)
38
	1: the plugin was activated normally
39
	2: the plugin was activated on this site because of a network-wide activation
40
	3: the plugin was auto-installed
41
	4: the plugin was manually disconnected (but is still installed)
42
43
jetpack_active_modules (array)
44
	Array of active module slugs.
45
46
jetpack_do_activate (bool)
47
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
48
*/
49
50
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
51
52
class Jetpack {
53
	public $xmlrpc_server = null;
54
55
	/**
56
	 * @var array The handles of styles that are concatenated into jetpack.css.
57
	 *
58
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
59
	 */
60
	public $concatenated_style_handles = array(
61
		'jetpack-carousel',
62
		'grunion.css',
63
		'the-neverending-homepage',
64
		'jetpack_likes',
65
		'jetpack_related-posts',
66
		'sharedaddy',
67
		'jetpack-slideshow',
68
		'presentations',
69
		'quiz',
70
		'jetpack-subscriptions',
71
		'jetpack-responsive-videos-style',
72
		'jetpack-social-menu',
73
		'tiled-gallery',
74
		'jetpack_display_posts_widget',
75
		'gravatar-profile-widget',
76
		'goodreads-widget',
77
		'jetpack_social_media_icons_widget',
78
		'jetpack-top-posts-widget',
79
		'jetpack_image_widget',
80
		'jetpack-my-community-widget',
81
		'jetpack-authors-widget',
82
		'wordads',
83
		'eu-cookie-law-style',
84
		'flickr-widget-style',
85
		'jetpack-search-widget',
86
		'jetpack-simple-payments-widget-style',
87
		'jetpack-widget-social-icons-styles',
88
		'wpcom_instagram_widget',
89
	);
90
91
	/**
92
	 * Contains all assets that have had their URL rewritten to minified versions.
93
	 *
94
	 * @var array
95
	 */
96
	static $min_assets = array();
97
98
	public $plugins_to_deactivate = array(
99
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
100
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
101
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
102
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
103
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
104
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
105
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
106
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
107
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
108
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
109
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
110
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
111
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
112
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
113
	);
114
115
	/**
116
	 * Map of roles we care about, and their corresponding minimum capabilities.
117
	 *
118
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
119
	 *
120
	 * @access public
121
	 * @static
122
	 *
123
	 * @var array
124
	 */
125
	public static $capability_translations = array(
126
		'administrator' => 'manage_options',
127
		'editor'        => 'edit_others_posts',
128
		'author'        => 'publish_posts',
129
		'contributor'   => 'edit_posts',
130
		'subscriber'    => 'read',
131
	);
132
133
	/**
134
	 * Map of modules that have conflicts with plugins and should not be auto-activated
135
	 * if the plugins are active.  Used by filter_default_modules
136
	 *
137
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
138
	 * change `module-slug` and add this to your plugin:
139
	 *
140
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
141
	 * function my_jetpack_get_default_modules( $modules ) {
142
	 *     return array_diff( $modules, array( 'module-slug' ) );
143
	 * }
144
	 *
145
	 * @var array
146
	 */
147
	private $conflicting_plugins = array(
148
		'comments'           => array(
149
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
150
			'Disqus'                         => 'disqus-comment-system/disqus.php',
151
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
152
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
153
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
154
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
155
		),
156
		'comment-likes'      => array(
157
			'Epoch' => 'epoch/plugincore.php',
158
		),
159
		'contact-form'       => array(
160
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
161
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
162
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
163
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
164
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
165
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
166
		),
167
		'latex'              => array(
168
			'LaTeX for WordPress'     => 'latex/latex.php',
169
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
170
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
171
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
172
			'Enable Latex'            => 'enable-latex/enable-latex.php',
173
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
174
		),
175
		'protect'            => array(
176
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
177
			'Captcha'                           => 'captcha/captcha.php',
178
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
179
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
180
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
181
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
182
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
183
			'Security-protection'               => 'security-protection/security-protection.php',
184
			'Login Security'                    => 'login-security/login-security.php',
185
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
186
			'Wordfence Security'                => 'wordfence/wordfence.php',
187
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
188
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
189
		),
190
		'random-redirect'    => array(
191
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
192
		),
193
		'related-posts'      => array(
194
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
195
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
196
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
197
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
198
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
199
			'outbrain'                    => 'outbrain/outbrain.php',
200
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
201
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
202
		),
203
		'sharedaddy'         => array(
204
			'AddThis'     => 'addthis/addthis_social_widget.php',
205
			'Add To Any'  => 'add-to-any/add-to-any.php',
206
			'ShareThis'   => 'share-this/sharethis.php',
207
			'Shareaholic' => 'shareaholic/shareaholic.php',
208
		),
209
		'seo-tools'          => array(
210
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
211
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
212
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
213
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
214
			'The SEO Framework'              => 'autodescription/autodescription.php',
215
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
216
			'Slim SEO'                       => 'slim-seo/slim-seo.php',
217
		),
218
		'verification-tools' => array(
219
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
220
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
221
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
222
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
223
			'The SEO Framework'              => 'autodescription/autodescription.php',
224
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
225
			'Slim SEO'                       => 'slim-seo/slim-seo.php',
226
		),
227
		'widget-visibility'  => array(
228
			'Widget Logic'    => 'widget-logic/widget_logic.php',
229
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
230
		),
231
		'sitemaps'           => array(
232
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
233
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
234
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
235
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
236
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
237
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
238
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
239
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
240
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
241
			'The SEO Framework'                    => 'autodescription/autodescription.php',
242
			'Sitemap'                              => 'sitemap/sitemap.php',
243
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
244
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
245
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
246
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
247
			'Rank Math'                            => 'seo-by-rank-math/rank-math.php',
248
			'Slim SEO'                             => 'slim-seo/slim-seo.php',
249
		),
250
		'lazy-images'        => array(
251
			'Lazy Load'              => 'lazy-load/lazy-load.php',
252
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
253
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
254
		),
255
	);
256
257
	/**
258
	 * Plugins for which we turn off our Facebook OG Tags implementation.
259
	 *
260
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
261
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
262
	 *
263
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
264
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
265
	 */
266
	private $open_graph_conflicting_plugins = array(
267
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
268
		// 2 Click Social Media Buttons
269
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
270
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
271
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
272
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
273
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
274
		// Open Graph Meta Tags by Heateor
275
		'facebook/facebook.php',                                 // Facebook (official plugin)
276
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
277
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
278
		// Facebook Featured Image & OG Meta Tags
279
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
280
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
281
		// Facebook Open Graph Meta Tags for WordPress
282
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
283
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
284
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
285
		// Fedmich's Facebook Open Graph Meta
286
		'network-publisher/networkpub.php',                      // Network Publisher
287
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
288
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
289
		// NextScripts SNAP
290
		'og-tags/og-tags.php',                                   // OG Tags
291
		'opengraph/opengraph.php',                               // Open Graph
292
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
293
		// Open Graph Protocol Framework
294
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
295
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
296
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
297
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
298
		'sharepress/sharepress.php',                             // SharePress
299
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
300
		'social-discussions/social-discussions.php',             // Social Discussions
301
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
302
		'socialize/socialize.php',                               // Socialize
303
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
304
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
305
		// Tweet, Like, Google +1 and Share
306
		'wordbooker/wordbooker.php',                             // Wordbooker
307
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
308
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
309
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
310
		// WP Facebook Like Send & Open Graph Meta
311
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
312
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
313
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
314
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
315
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
316
		'seo-by-rank-math/rank-math.php',                        // Rank Math.
317
		'slim-seo/slim-seo.php',                                 // Slim SEO
318
	);
319
320
	/**
321
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
322
	 */
323
	private $twitter_cards_conflicting_plugins = array(
324
		// 'twitter/twitter.php',                       // The official one handles this on its own.
325
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
326
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
327
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
328
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
329
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
330
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
331
		'twitter-cards/twitter-cards.php',           // Twitter Cards
332
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
333
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
334
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
335
		'seo-by-rank-math/rank-math.php',            // Rank Math.
336
		'slim-seo/slim-seo.php',                     // Slim SEO
337
	);
338
339
	/**
340
	 * Message to display in admin_notice
341
	 *
342
	 * @var string
343
	 */
344
	public $message = '';
345
346
	/**
347
	 * Error to display in admin_notice
348
	 *
349
	 * @var string
350
	 */
351
	public $error = '';
352
353
	/**
354
	 * Modules that need more privacy description.
355
	 *
356
	 * @var string
357
	 */
358
	public $privacy_checks = '';
359
360
	/**
361
	 * Stats to record once the page loads
362
	 *
363
	 * @var array
364
	 */
365
	public $stats = array();
366
367
	/**
368
	 * Jetpack_Sync object
369
	 */
370
	public $sync;
371
372
	/**
373
	 * Verified data for JSON authorization request
374
	 */
375
	public $json_api_authorization_request = array();
376
377
	/**
378
	 * @var Automattic\Jetpack\Connection\Manager
379
	 */
380
	protected $connection_manager;
381
382
	/**
383
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
384
	 */
385
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
386
387
	/**
388
	 * Holds an instance of Automattic\Jetpack\A8c_Mc_Stats
389
	 *
390
	 * @var Automattic\Jetpack\A8c_Mc_Stats
391
	 */
392
	public $a8c_mc_stats_instance;
393
394
	/**
395
	 * Constant for login redirect key.
396
	 *
397
	 * @var string
398
	 * @since 8.4.0
399
	 */
400
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
401
402
	/**
403
	 * Holds the singleton instance of this class
404
	 *
405
	 * @since 2.3.3
406
	 * @var Jetpack
407
	 */
408
	static $instance = false;
409
410
	/**
411
	 * Singleton
412
	 *
413
	 * @static
414
	 */
415
	public static function init() {
416
		if ( ! self::$instance ) {
417
			self::$instance = new Jetpack();
418
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
419
		}
420
421
		return self::$instance;
422
	}
423
424
	/**
425
	 * Must never be called statically
426
	 */
427
	function plugin_upgrade() {
428
		if ( self::is_active() ) {
429
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
430
			if ( JETPACK__VERSION != $version ) {
431
				// Prevent multiple upgrades at once - only a single process should trigger
432
				// an upgrade to avoid stampedes
433
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
434
					return;
435
				}
436
437
				// Set a short lock to prevent multiple instances of the upgrade
438
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
439
440
				// check which active modules actually exist and remove others from active_modules list
441
				$unfiltered_modules = self::get_active_modules();
442
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
443
				if ( array_diff( $unfiltered_modules, $modules ) ) {
444
					self::update_active_modules( $modules );
445
				}
446
447
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
448
449
				// Upgrade to 4.3.0
450
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
451
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
452
				}
453
454
				// Make sure Markdown for posts gets turned back on
455
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
456
					update_option( 'wpcom_publish_posts_with_markdown', true );
457
				}
458
459
				/*
460
				 * Minileven deprecation. 8.3.0.
461
				 * Only delete options if not using
462
				 * the replacement standalone Minileven plugin.
463
				 */
464
				if (
465
					! self::is_plugin_active( 'minileven-master/minileven.php' )
466
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
467
				) {
468
					if ( get_option( 'wp_mobile_custom_css' ) ) {
469
						delete_option( 'wp_mobile_custom_css' );
470
					}
471
					if ( get_option( 'wp_mobile_excerpt' ) ) {
472
						delete_option( 'wp_mobile_excerpt' );
473
					}
474
					if ( get_option( 'wp_mobile_featured_images' ) ) {
475
						delete_option( 'wp_mobile_featured_images' );
476
					}
477
					if ( get_option( 'wp_mobile_app_promos' ) ) {
478
						delete_option( 'wp_mobile_app_promos' );
479
					}
480
				}
481
482
				// Upgrade to 8.4.0.
483
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
484
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
485
				}
486
487
				// Update to 8.8.x (WordPress 5.5 Compatibility).
488
				if ( Jetpack_Options::get_option( 'autoupdate_plugins' ) ) {
489
					$updated = update_site_option(
490
						'auto_update_plugins',
491
						array_unique(
492
							array_merge(
493
								(array) Jetpack_Options::get_option( 'autoupdate_plugins', array() ),
494
								(array) get_site_option( 'auto_update_plugins', array() )
495
							)
496
						)
497
					);
498
499
					if ( $updated ) {
500
						Jetpack_Options::delete_option( 'autoupdate_plugins' );
501
					} // Should we have some type of fallback if something fails here?
502
				}
503
504
				if ( did_action( 'wp_loaded' ) ) {
505
					self::upgrade_on_load();
506
				} else {
507
					add_action(
508
						'wp_loaded',
509
						array( __CLASS__, 'upgrade_on_load' )
510
					);
511
				}
512
			}
513
		}
514
	}
515
516
	/**
517
	 * Runs upgrade routines that need to have modules loaded.
518
	 */
519
	static function upgrade_on_load() {
520
521
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
522
		// This can happen in case Jetpack has been just upgraded and is
523
		// being initialized late during the page load. In this case we wait
524
		// until the next proper admin page load with Jetpack active.
525
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
526
			delete_transient( self::$plugin_upgrade_lock_key );
527
528
			return;
529
		}
530
531
		self::maybe_set_version_option();
532
533
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
534
			Jetpack_Widget_Conditions::migrate_post_type_rules();
535
		}
536
537
		if (
538
			class_exists( 'Jetpack_Sitemap_Manager' )
539
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
540
		) {
541
			do_action( 'jetpack_sitemaps_purge_data' );
542
		}
543
544
		// Delete old stats cache
545
		delete_option( 'jetpack_restapi_stats_cache' );
546
547
		delete_transient( self::$plugin_upgrade_lock_key );
548
	}
549
550
	/**
551
	 * Saves all the currently active modules to options.
552
	 * Also fires Action hooks for each newly activated and deactivated module.
553
	 *
554
	 * @param $modules Array Array of active modules to be saved in options.
555
	 *
556
	 * @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...
557
	 */
558
	static function update_active_modules( $modules ) {
559
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
560
		$active_modules       = self::get_active_modules();
561
		$new_active_modules   = array_diff( $modules, $current_modules );
562
		$new_inactive_modules = array_diff( $active_modules, $modules );
563
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
564
		$reindexed_modules    = array_values( $new_current_modules );
565
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
566
567
		foreach ( $new_active_modules as $module ) {
568
			/**
569
			 * Fires when a specific module is activated.
570
			 *
571
			 * @since 1.9.0
572
			 *
573
			 * @param string $module Module slug.
574
			 * @param boolean $success whether the module was activated. @since 4.2
575
			 */
576
			do_action( 'jetpack_activate_module', $module, $success );
577
			/**
578
			 * Fires when a module is activated.
579
			 * The dynamic part of the filter, $module, is the module slug.
580
			 *
581
			 * @since 1.9.0
582
			 *
583
			 * @param string $module Module slug.
584
			 */
585
			do_action( "jetpack_activate_module_$module", $module );
586
		}
587
588
		foreach ( $new_inactive_modules as $module ) {
589
			/**
590
			 * Fired after a module has been deactivated.
591
			 *
592
			 * @since 4.2.0
593
			 *
594
			 * @param string $module Module slug.
595
			 * @param boolean $success whether the module was deactivated.
596
			 */
597
			do_action( 'jetpack_deactivate_module', $module, $success );
598
			/**
599
			 * Fires when a module is deactivated.
600
			 * The dynamic part of the filter, $module, is the module slug.
601
			 *
602
			 * @since 1.9.0
603
			 *
604
			 * @param string $module Module slug.
605
			 */
606
			do_action( "jetpack_deactivate_module_$module", $module );
607
		}
608
609
		return $success;
610
	}
611
612
	static function delete_active_modules() {
613
		self::update_active_modules( array() );
614
	}
615
616
	/**
617
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
618
	 * available.
619
	 */
620
	public function add_configure_hook() {
621
		global $wp_filter;
622
623
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
624
		if ( false !== $current_priority ) {
625
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
626
		}
627
628
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
629
		sort( $taken_priorities );
630
631
		$first_priority = array_shift( $taken_priorities );
632
633
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
634
			$new_priority = - PHP_INT_MAX;
635
		} else {
636
			$new_priority = $first_priority - 1;
637
		}
638
639
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
640
	}
641
642
	/**
643
	 * Constructor.  Initializes WordPress hooks
644
	 */
645
	private function __construct() {
646
		/*
647
		 * Check for and alert any deprecated hooks
648
		 */
649
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
650
651
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
652
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
653
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
654
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
655
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
656
657
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
658
659
		add_filter(
660
			'jetpack_signature_check_token',
661
			array( __CLASS__, 'verify_onboarding_token' ),
662
			10,
663
			3
664
		);
665
666
		/**
667
		 * Prepare Gutenberg Editor functionality
668
		 */
669
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
670
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
671
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
672
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_extended_blocks' ), 9 );
673
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
674
675
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
676
677
		// Unlink user before deleting the user from WP.com.
678
		add_action( 'deleted_user', array( $this, 'disconnect_user' ), 10, 1 );
679
		add_action( 'remove_user_from_blog', array( $this, 'disconnect_user' ), 10, 1 );
680
681
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
682
683
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
684
		add_action( 'login_init', array( $this, 'login_init' ) );
685
686
		// Set up the REST authentication hooks.
687
		Connection_Rest_Authentication::init();
688
689
		add_action( 'admin_init', array( $this, 'admin_init' ) );
690
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
691
692
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
693
694
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
695
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
696
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
697
698
		// returns HTTPS support status
699
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
700
701
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
702
703
		add_action( 'wp_ajax_jetpack_recommendations_banner', array( 'Jetpack_Recommendations_Banner', 'ajax_callback' ) );
704
705
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
706
707
		/**
708
		 * These actions run checks to load additional files.
709
		 * They check for external files or plugins, so they need to run as late as possible.
710
		 */
711
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
712
		add_action( 'web_stories_story_head', array( $this, 'check_open_graph' ), 1 );
713
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
714
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
715
716
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
717
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
718
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
719
720
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
721
722
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
723
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
724
725
		// A filter to control all just in time messages
726
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
727
728
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
729
730
		/*
731
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
732
		 * We should make sure to only do this for front end links.
733
		 */
734
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
735
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
736
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
737
738
			/*
739
			 * We'll shortcircuit wp_notify_postauthor and wp_notify_moderator pluggable functions
740
			 * so they point moderation links on emails to Calypso.
741
			 */
742
			jetpack_require_lib( 'functions.wp-notify' );
743
			add_filter( 'comment_notification_recipients', 'jetpack_notify_postauthor', 1, 2 );
744
			add_filter( 'notify_moderator', 'jetpack_notify_moderator', 1, 2 );
745
		}
746
747
		add_action(
748
			'plugins_loaded',
749
			function () {
750
				if ( User_Agent_Info::is_mobile_app() ) {
751
					add_filter( 'get_edit_post_link', '__return_empty_string' );
752
				}
753
			}
754
		);
755
756
		// Update the site's Jetpack plan and products from API on heartbeats.
757
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
758
759
		/**
760
		 * This is the hack to concatenate all css files into one.
761
		 * For description and reasoning see the implode_frontend_css method.
762
		 *
763
		 * Super late priority so we catch all the registered styles.
764
		 */
765
		if ( ! is_admin() ) {
766
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
767
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
768
		}
769
770
		/**
771
		 * These are sync actions that we need to keep track of for jitms
772
		 */
773
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
774
775
		// Actually push the stats on shutdown.
776
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
777
			add_action( 'shutdown', array( $this, 'push_stats' ) );
778
		}
779
780
		// Actions for Manager::authorize().
781
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
782
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
783
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
784
785
		add_action( 'jetpack_client_authorize_error', array( Jetpack_Client_Server::class, 'client_authorize_error' ) );
786
		add_filter( 'jetpack_client_authorize_already_authorized_url', array( Jetpack_Client_Server::class, 'client_authorize_already_authorized_url' ) );
787
		add_action( 'jetpack_client_authorize_processing', array( Jetpack_Client_Server::class, 'client_authorize_processing' ) );
788
		add_filter( 'jetpack_client_authorize_fallback_url', array( Jetpack_Client_Server::class, 'client_authorize_fallback_url' ) );
789
790
		// Filters for the Manager::get_token() urls and request body.
791
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
792
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
793
794
		// Actions for successful reconnect.
795
		add_action( 'jetpack_reconnection_completed', array( $this, 'reconnection_completed' ) );
796
797
		// Actions for licensing.
798
		Licensing::instance()->initialize();
799
800
		// Filters for Sync Callables.
801
		add_filter( 'jetpack_sync_callable_whitelist', array( $this, 'filter_sync_callable_whitelist' ), 10, 1 );
802
803
		// Make resources use static domain when possible.
804
		add_filter( 'jetpack_static_url', array( 'Automattic\\Jetpack\\Assets', 'staticize_subdomain' ) );
805
	}
806
807
	/**
808
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
809
	 * Config object.
810
	 */
811
	public function configure() {
812
		$config = new Config();
813
814
		foreach (
815
			array(
816
				'sync',
817
			)
818
			as $feature
819
		) {
820
			$config->ensure( $feature );
821
		}
822
823
		$config->ensure(
824
			'connection',
825
			array(
826
				'slug' => 'jetpack',
827
				'name' => 'Jetpack',
828
			)
829
		);
830
831
		if ( is_admin() ) {
832
			$config->ensure( 'jitm' );
833
		}
834
835
		if ( ! $this->connection_manager ) {
836
			$this->connection_manager = new Connection_Manager( 'jetpack' );
837
838
			/**
839
			 * Filter to activate Jetpack Connection UI.
840
			 * INTERNAL USE ONLY.
841
			 *
842
			 * @since 9.5.0
843
			 *
844
			 * @param bool false Whether to activate the Connection UI.
845
			 */
846
			if ( apply_filters( 'jetpack_connection_ui_active', false ) ) {
847
				Automattic\Jetpack\ConnectionUI\Admin::init();
848
			}
849
		}
850
851
		/*
852
		 * Load things that should only be in Network Admin.
853
		 *
854
		 * For now blow away everything else until a more full
855
		 * understanding of what is needed at the network level is
856
		 * available
857
		 */
858
		if ( is_multisite() ) {
859
			$network = Jetpack_Network::init();
860
			$network->set_connection( $this->connection_manager );
861
		}
862
863
		if ( $this->connection_manager->is_active() ) {
864
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
865
866
			Jetpack_Heartbeat::init();
867
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
868
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
869
				Jetpack_Search_Performance_Logger::init();
870
			}
871
		}
872
873
		// Initialize remote file upload request handlers.
874
		$this->add_remote_request_handlers();
875
876
		/*
877
		 * Enable enhanced handling of previewing sites in Calypso
878
		 */
879
		if ( self::is_active() ) {
880
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
881
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
882
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
883
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
884
		}
885
886
		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...
887
			add_action( 'init', array( new Plugin_Tracking(), 'init' ) );
888
		} else {
889
			/**
890
			 * Initialize tracking right after the user agrees to the terms of service.
891
			 */
892
			add_action( 'jetpack_agreed_to_terms_of_service', array( new Plugin_Tracking(), 'init' ) );
893
		}
894
	}
895
896
	/**
897
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
898
	 * initialization code.
899
	 *
900
	 * @action plugins_loaded
901
	 */
902
	public function late_initialization() {
903
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
904
905
		Partner::init();
906
907
		/**
908
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
909
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
910
		 *
911
		 * @since 8.1.0
912
		 *
913
		 * @param Jetpack $jetpack the main plugin class object.
914
		 */
915
		do_action( 'jetpack_loaded', $this );
916
917
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
918
	}
919
920
	/**
921
	 * Sets up the XMLRPC request handlers.
922
	 *
923
	 * @deprecated since 7.7.0
924
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
925
	 *
926
	 * @param array                 $request_params Incoming request parameters.
927
	 * @param Boolean               $is_active      Whether the connection is currently active.
928
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
929
	 * @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...
930
	 */
931 View Code Duplication
	public function setup_xmlrpc_handlers(
932
		$request_params,
933
		$is_active,
934
		$is_signed,
935
		Jetpack_XMLRPC_Server $xmlrpc_server = null
936
	) {
937
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
938
939
		if ( ! $this->connection_manager ) {
940
			$this->connection_manager = new Connection_Manager();
941
		}
942
943
		return $this->connection_manager->setup_xmlrpc_handlers(
944
			$request_params,
945
			$is_active,
946
			$is_signed,
947
			$xmlrpc_server
948
		);
949
	}
950
951
	/**
952
	 * Initialize REST API registration connector.
953
	 *
954
	 * @deprecated since 7.7.0
955
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
956
	 */
957 View Code Duplication
	public function initialize_rest_api_registration_connector() {
958
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
959
960
		if ( ! $this->connection_manager ) {
961
			$this->connection_manager = new Connection_Manager();
962
		}
963
964
		$this->connection_manager->initialize_rest_api_registration_connector();
965
	}
966
967
	/**
968
	 * This is ported over from the manage module, which has been deprecated and baked in here.
969
	 *
970
	 * @param $domains
971
	 */
972
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
973
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
974
	}
975
976
	/**
977
	 * Return $domains, with 'wordpress.com' appended.
978
	 * This is ported over from the manage module, which has been deprecated and baked in here.
979
	 *
980
	 * @param $domains
981
	 * @return array
982
	 */
983
	function allow_wpcom_domain( $domains ) {
984
		if ( empty( $domains ) ) {
985
			$domains = array();
986
		}
987
		$domains[] = 'wordpress.com';
988
		return array_unique( $domains );
989
	}
990
991
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
992
		$post = get_post( $post_id );
993
994
		if ( empty( $post ) ) {
995
			return $default_url;
996
		}
997
998
		$post_type = $post->post_type;
999
1000
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
1001
		// https://en.support.wordpress.com/custom-post-types/
1002
		$allowed_post_types = array(
1003
			'post',
1004
			'page',
1005
			'jetpack-portfolio',
1006
			'jetpack-testimonial',
1007
		);
1008
1009
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
1010
			return $default_url;
1011
		}
1012
1013
		return Redirect::get_url(
1014
			'calypso-edit-' . $post_type,
1015
			array(
1016
				'path' => $post_id,
1017
			)
1018
		);
1019
	}
1020
1021
	function point_edit_comment_links_to_calypso( $url ) {
1022
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
1023
		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...
1024
1025
		return Redirect::get_url(
1026
			'calypso-edit-comment',
1027
			array(
1028
				'path' => $query_args['amp;c'],
1029
			)
1030
		);
1031
1032
	}
1033
1034
	/**
1035
	 * Extend callables with Jetpack Plugin functions.
1036
	 *
1037
	 * @param array $callables list of callables.
1038
	 *
1039
	 * @return array list of callables.
1040
	 */
1041
	public function filter_sync_callable_whitelist( $callables ) {
1042
1043
		// Jetpack Functions.
1044
		$jetpack_callables = array(
1045
			'single_user_site'         => array( 'Jetpack', 'is_single_user_site' ),
1046
			'updates'                  => array( 'Jetpack', 'get_updates' ),
1047
			'active_modules'           => array( 'Jetpack', 'get_active_modules' ),
1048
			'available_jetpack_blocks' => array( 'Jetpack_Gutenberg', 'get_availability' ), // Includes both Gutenberg blocks *and* plugins.
1049
		);
1050
		$callables         = array_merge( $callables, $jetpack_callables );
1051
1052
		// Jetpack_SSO_Helpers.
1053
		if ( include_once JETPACK__PLUGIN_DIR . 'modules/sso/class.jetpack-sso-helpers.php' ) {
1054
			$sso_helpers = array(
1055
				'sso_is_two_step_required'      => array( 'Jetpack_SSO_Helpers', 'is_two_step_required' ),
1056
				'sso_should_hide_login_form'    => array( 'Jetpack_SSO_Helpers', 'should_hide_login_form' ),
1057
				'sso_match_by_email'            => array( 'Jetpack_SSO_Helpers', 'match_by_email' ),
1058
				'sso_new_user_override'         => array( 'Jetpack_SSO_Helpers', 'new_user_override' ),
1059
				'sso_bypass_default_login_form' => array( 'Jetpack_SSO_Helpers', 'bypass_login_forward_wpcom' ),
1060
			);
1061
			$callables   = array_merge( $callables, $sso_helpers );
1062
		}
1063
1064
		return $callables;
1065
	}
1066
1067
	function jetpack_track_last_sync_callback( $params ) {
1068
		/**
1069
		 * Filter to turn off jitm caching
1070
		 *
1071
		 * @since 5.4.0
1072
		 *
1073
		 * @param bool false Whether to cache just in time messages
1074
		 */
1075
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
1076
			return $params;
1077
		}
1078
1079
		if ( is_array( $params ) && isset( $params[0] ) ) {
1080
			$option = $params[0];
1081
			if ( 'active_plugins' === $option ) {
1082
				// use the cache if we can, but not terribly important if it gets evicted
1083
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
1084
			}
1085
		}
1086
1087
		return $params;
1088
	}
1089
1090
	function jetpack_connection_banner_callback() {
1091
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
1092
1093
		// Disable the banner dismiss functionality if the pre-connection prompt helpers filter is set.
1094
		if (
1095
			isset( $_REQUEST['dismissBanner'] ) &&
1096
			! Jetpack_Connection_Banner::force_display()
1097
		) {
1098
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
1099
			wp_send_json_success();
1100
		}
1101
1102
		wp_die();
1103
	}
1104
1105
	/**
1106
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1107
	 * Only used in our alternate XML-RPC endpoint, where we want to
1108
	 * ensure that Core and other plugins' methods are not exposed.
1109
	 *
1110
	 * @deprecated since 7.7.0
1111
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1112
	 *
1113
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1114
	 * @return array Filtered $methods
1115
	 */
1116 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1117
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1118
1119
		if ( ! $this->connection_manager ) {
1120
			$this->connection_manager = new Connection_Manager();
1121
		}
1122
1123
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1124
	}
1125
1126
	/**
1127
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1128
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1129
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1130
	 * which is accessible via a different URI. Most of the below is copied directly
1131
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1132
	 *
1133
	 * @deprecated since 7.7.0
1134
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1135
	 */
1136 View Code Duplication
	public function alternate_xmlrpc() {
1137
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1138
1139
		if ( ! $this->connection_manager ) {
1140
			$this->connection_manager = new Connection_Manager();
1141
		}
1142
1143
		$this->connection_manager->alternate_xmlrpc();
1144
	}
1145
1146
	/**
1147
	 * The callback for the JITM ajax requests.
1148
	 *
1149
	 * @deprecated since 7.9.0
1150
	 */
1151
	function jetpack_jitm_ajax_callback() {
1152
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1153
	}
1154
1155
	/**
1156
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1157
	 */
1158
	function push_stats() {
1159
		if ( ! empty( $this->stats ) ) {
1160
			$this->do_stats( 'server_side' );
1161
		}
1162
	}
1163
1164
	/**
1165
	 * Sets the Jetpack custom capabilities.
1166
	 *
1167
	 * @param string[] $caps    Array of the user's capabilities.
1168
	 * @param string   $cap     Capability name.
1169
	 * @param int      $user_id The user ID.
1170
	 * @param array    $args    Adds the context to the cap. Typically the object ID.
1171
	 */
1172
	public function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1173
		switch ( $cap ) {
1174
			case 'jetpack_manage_modules':
1175
			case 'jetpack_activate_modules':
1176
			case 'jetpack_deactivate_modules':
1177
				$caps = array( 'manage_options' );
1178
				break;
1179
			case 'jetpack_configure_modules':
1180
				$caps = array( 'manage_options' );
1181
				break;
1182
			case 'jetpack_manage_autoupdates':
1183
				$caps = array(
1184
					'manage_options',
1185
					'update_plugins',
1186
				);
1187
				break;
1188
			case 'jetpack_network_admin_page':
1189
			case 'jetpack_network_settings_page':
1190
				$caps = array( 'manage_network_plugins' );
1191
				break;
1192
			case 'jetpack_network_sites_page':
1193
				$caps = array( 'manage_sites' );
1194
				break;
1195 View Code Duplication
			case 'jetpack_admin_page':
1196
				$is_offline_mode = ( new Status() )->is_offline_mode();
1197
				if ( $is_offline_mode ) {
1198
					$caps = array( 'manage_options' );
1199
					break;
1200
				} else {
1201
					$caps = array( 'read' );
1202
				}
1203
				break;
1204
		}
1205
		return $caps;
1206
	}
1207
1208
	/**
1209
	 * Require a Jetpack authentication.
1210
	 *
1211
	 * @deprecated since 7.7.0
1212
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1213
	 */
1214 View Code Duplication
	public function require_jetpack_authentication() {
1215
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1216
1217
		if ( ! $this->connection_manager ) {
1218
			$this->connection_manager = new Connection_Manager();
1219
		}
1220
1221
		$this->connection_manager->require_jetpack_authentication();
1222
	}
1223
1224
	/**
1225
	 * Register assets for use in various modules and the Jetpack admin page.
1226
	 *
1227
	 * @uses wp_script_is, wp_register_script, plugins_url
1228
	 * @action wp_loaded
1229
	 * @return null
1230
	 */
1231
	public function register_assets() {
1232 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1233
			wp_register_script(
1234
				'jetpack-gallery-settings',
1235
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1236
				array( 'media-views' ),
1237
				'20121225'
1238
			);
1239
		}
1240
1241
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1242
			wp_register_script(
1243
				'jetpack-twitter-timeline',
1244
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1245
				array( 'jquery' ),
1246
				'4.0.0',
1247
				true
1248
			);
1249
		}
1250
1251
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1252
			wp_register_script(
1253
				'jetpack-facebook-embed',
1254
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1255
				array(),
1256
				null,
1257
				true
1258
			);
1259
1260
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1261
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1262
			if ( ! is_numeric( $fb_app_id ) ) {
1263
				$fb_app_id = '';
1264
			}
1265
			wp_localize_script(
1266
				'jetpack-facebook-embed',
1267
				'jpfbembed',
1268
				array(
1269
					'appid'  => $fb_app_id,
1270
					'locale' => $this->get_locale(),
1271
				)
1272
			);
1273
		}
1274
1275
		/**
1276
		 * As jetpack_register_genericons is by default fired off a hook,
1277
		 * the hook may have already fired by this point.
1278
		 * So, let's just trigger it manually.
1279
		 */
1280
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1281
		jetpack_register_genericons();
1282
1283
		/**
1284
		 * Register the social logos
1285
		 */
1286
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1287
		jetpack_register_social_logos();
1288
1289
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1290
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1291
		}
1292
	}
1293
1294
	/**
1295
	 * Guess locale from language code.
1296
	 *
1297
	 * @param string $lang Language code.
1298
	 * @return string|bool
1299
	 */
1300 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1301
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1302
			return 'en_US';
1303
		}
1304
1305
		if ( ! class_exists( 'GP_Locales' ) ) {
1306
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1307
				return false;
1308
			}
1309
1310
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1311
		}
1312
1313
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1314
			// WP.com: get_locale() returns 'it'
1315
			$locale = GP_Locales::by_slug( $lang );
1316
		} else {
1317
			// Jetpack: get_locale() returns 'it_IT';
1318
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1319
		}
1320
1321
		if ( ! $locale ) {
1322
			return false;
1323
		}
1324
1325
		if ( empty( $locale->facebook_locale ) ) {
1326
			if ( empty( $locale->wp_locale ) ) {
1327
				return false;
1328
			} else {
1329
				// Facebook SDK is smart enough to fall back to en_US if a
1330
				// locale isn't supported. Since supported Facebook locales
1331
				// can fall out of sync, we'll attempt to use the known
1332
				// wp_locale value and rely on said fallback.
1333
				return $locale->wp_locale;
1334
			}
1335
		}
1336
1337
		return $locale->facebook_locale;
1338
	}
1339
1340
	/**
1341
	 * Get the locale.
1342
	 *
1343
	 * @return string|bool
1344
	 */
1345
	function get_locale() {
1346
		$locale = $this->guess_locale_from_lang( get_locale() );
1347
1348
		if ( ! $locale ) {
1349
			$locale = 'en_US';
1350
		}
1351
1352
		return $locale;
1353
	}
1354
1355
	/**
1356
	 * Return the network_site_url so that .com knows what network this site is a part of.
1357
	 *
1358
	 * @param  bool $option
1359
	 * @return string
1360
	 */
1361
	public function jetpack_main_network_site_option( $option ) {
1362
		return network_site_url();
1363
	}
1364
	/**
1365
	 * Network Name.
1366
	 */
1367
	static function network_name( $option = null ) {
1368
		global $current_site;
1369
		return $current_site->site_name;
1370
	}
1371
	/**
1372
	 * Does the network allow new user and site registrations.
1373
	 *
1374
	 * @return string
1375
	 */
1376
	static function network_allow_new_registrations( $option = null ) {
1377
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1378
	}
1379
	/**
1380
	 * Does the network allow admins to add new users.
1381
	 *
1382
	 * @return boolian
1383
	 */
1384
	static function network_add_new_users( $option = null ) {
1385
		return (bool) get_site_option( 'add_new_users' );
1386
	}
1387
	/**
1388
	 * File upload psace left per site in MB.
1389
	 *  -1 means NO LIMIT.
1390
	 *
1391
	 * @return number
1392
	 */
1393
	static function network_site_upload_space( $option = null ) {
1394
		// value in MB
1395
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1396
	}
1397
1398
	/**
1399
	 * Network allowed file types.
1400
	 *
1401
	 * @return string
1402
	 */
1403
	static function network_upload_file_types( $option = null ) {
1404
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1405
	}
1406
1407
	/**
1408
	 * Maximum file upload size set by the network.
1409
	 *
1410
	 * @return number
1411
	 */
1412
	static function network_max_upload_file_size( $option = null ) {
1413
		// value in KB
1414
		return get_site_option( 'fileupload_maxk', 300 );
1415
	}
1416
1417
	/**
1418
	 * Lets us know if a site allows admins to manage the network.
1419
	 *
1420
	 * @return array
1421
	 */
1422
	static function network_enable_administration_menus( $option = null ) {
1423
		return get_site_option( 'menu_items' );
1424
	}
1425
1426
	/**
1427
	 * If a user has been promoted to or demoted from admin, we need to clear the
1428
	 * jetpack_other_linked_admins transient.
1429
	 *
1430
	 * @since 4.3.2
1431
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1432
	 *
1433
	 * @param int    $user_id   The user ID whose role changed.
1434
	 * @param string $role      The new role.
1435
	 * @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...
1436
	 */
1437
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1438
		if ( 'administrator' == $role
1439
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1440
			|| is_null( $old_roles )
1441
		) {
1442
			delete_transient( 'jetpack_other_linked_admins' );
1443
		}
1444
	}
1445
1446
	/**
1447
	 * Checks to see if there are any other users available to become primary
1448
	 * Users must both:
1449
	 * - Be linked to wpcom
1450
	 * - Be an admin
1451
	 *
1452
	 * @return mixed False if no other users are linked, Int if there are.
1453
	 */
1454
	static function get_other_linked_admins() {
1455
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1456
1457
		if ( false === $other_linked_users ) {
1458
			$admins = get_users( array( 'role' => 'administrator' ) );
1459
			if ( count( $admins ) > 1 ) {
1460
				$available = array();
1461
				foreach ( $admins as $admin ) {
1462
					if ( self::connection()->is_user_connected( $admin->ID ) ) {
1463
						$available[] = $admin->ID;
1464
					}
1465
				}
1466
1467
				$count_connected_admins = count( $available );
1468
				if ( count( $available ) > 1 ) {
1469
					$other_linked_users = $count_connected_admins;
1470
				} else {
1471
					$other_linked_users = 0;
1472
				}
1473
			} else {
1474
				$other_linked_users = 0;
1475
			}
1476
1477
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1478
		}
1479
1480
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1481
	}
1482
1483
	/**
1484
	 * Return whether we are dealing with a multi network setup or not.
1485
	 * The reason we are type casting this is because we want to avoid the situation where
1486
	 * the result is false since when is_main_network_option return false it cases
1487
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1488
	 * database which could be set to anything as opposed to what this function returns.
1489
	 *
1490
	 * @param  bool $option
1491
	 *
1492
	 * @return boolean
1493
	 */
1494
	public function is_main_network_option( $option ) {
1495
		// return '1' or ''
1496
		return (string) (bool) self::is_multi_network();
1497
	}
1498
1499
	/**
1500
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1501
	 *
1502
	 * @param  string $option
1503
	 * @return boolean
1504
	 */
1505
	public function is_multisite( $option ) {
1506
		return (string) (bool) is_multisite();
1507
	}
1508
1509
	/**
1510
	 * Implemented since there is no core is multi network function
1511
	 * Right now there is no way to tell if we which network is the dominant network on the system
1512
	 *
1513
	 * @since  3.3
1514
	 * @return boolean
1515
	 */
1516 View Code Duplication
	public static function is_multi_network() {
1517
		global  $wpdb;
1518
1519
		// if we don't have a multi site setup no need to do any more
1520
		if ( ! is_multisite() ) {
1521
			return false;
1522
		}
1523
1524
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1525
		if ( $num_sites > 1 ) {
1526
			return true;
1527
		} else {
1528
			return false;
1529
		}
1530
	}
1531
1532
	/**
1533
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1534
	 *
1535
	 * @return null
1536
	 */
1537
	function update_jetpack_main_network_site_option() {
1538
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1539
	}
1540
	/**
1541
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1542
	 */
1543
	function update_jetpack_network_settings() {
1544
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1545
		// Only sync this info for the main network site.
1546
	}
1547
1548
	/**
1549
	 * Get back if the current site is single user site.
1550
	 *
1551
	 * @return bool
1552
	 */
1553 View Code Duplication
	public static function is_single_user_site() {
1554
		global $wpdb;
1555
1556
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1557
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1558
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1559
		}
1560
		return 1 === (int) $some_users;
1561
	}
1562
1563
	/**
1564
	 * Returns true if the site has file write access false otherwise.
1565
	 *
1566
	 * @return string ( '1' | '0' )
1567
	 **/
1568
	public static function file_system_write_access() {
1569
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1570
			require_once ABSPATH . 'wp-admin/includes/file.php';
1571
		}
1572
1573
		require_once ABSPATH . 'wp-admin/includes/template.php';
1574
1575
		$filesystem_method = get_filesystem_method();
1576
		if ( $filesystem_method === 'direct' ) {
1577
			return 1;
1578
		}
1579
1580
		ob_start();
1581
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1582
		ob_end_clean();
1583
		if ( $filesystem_credentials_are_stored ) {
1584
			return 1;
1585
		}
1586
		return 0;
1587
	}
1588
1589
	/**
1590
	 * Finds out if a site is using a version control system.
1591
	 *
1592
	 * @return string ( '1' | '0' )
1593
	 **/
1594
	public static function is_version_controlled() {
1595
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1596
		return (string) (int) Functions::is_version_controlled();
1597
	}
1598
1599
	/**
1600
	 * Determines whether the current theme supports featured images or not.
1601
	 *
1602
	 * @return string ( '1' | '0' )
1603
	 */
1604
	public static function featured_images_enabled() {
1605
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1606
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1607
	}
1608
1609
	/**
1610
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1611
	 *
1612
	 * @deprecated 4.7 use get_avatar_url instead.
1613
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1614
	 * @param int               $size Size of the avatar image
1615
	 * @param string            $default URL to a default image to use if no avatar is available
1616
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1617
	 *
1618
	 * @return array
1619
	 */
1620
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1621
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1622
		return get_avatar_url(
1623
			$id_or_email,
1624
			array(
1625
				'size'          => $size,
1626
				'default'       => $default,
1627
				'force_default' => $force_display,
1628
			)
1629
		);
1630
	}
1631
// phpcs:disable WordPress.WP.CapitalPDangit.Misspelled
1632
	/**
1633
	 * jetpack_updates is saved in the following schema:
1634
	 *
1635
	 * array (
1636
	 *      'plugins'                       => (int) Number of plugin updates available.
1637
	 *      'themes'                        => (int) Number of theme updates available.
1638
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1639
	 *      'translations'                  => (int) Number of translation updates available.
1640
	 *      'total'                         => (int) Total of all available updates.
1641
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1642
	 * )
1643
	 *
1644
	 * @return array
1645
	 */
1646
	public static function get_updates() {
1647
		$update_data = wp_get_update_data();
1648
1649
		// Stores the individual update counts as well as the total count.
1650
		if ( isset( $update_data['counts'] ) ) {
1651
			$updates = $update_data['counts'];
1652
		}
1653
1654
		// If we need to update WordPress core, let's find the latest version number.
1655 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1656
			$cur = get_preferred_from_update_core();
1657
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1658
				$updates['wp_update_version'] = $cur->current;
1659
			}
1660
		}
1661
		return isset( $updates ) ? $updates : array();
1662
	}
1663
	// phpcs:enable
1664
1665
	public static function get_update_details() {
1666
		$update_details = array(
1667
			'update_core'    => get_site_transient( 'update_core' ),
1668
			'update_plugins' => get_site_transient( 'update_plugins' ),
1669
			'update_themes'  => get_site_transient( 'update_themes' ),
1670
		);
1671
		return $update_details;
1672
	}
1673
1674
	public static function refresh_update_data() {
1675
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1676
1677
	}
1678
1679
	public static function refresh_theme_data() {
1680
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1681
	}
1682
1683
	/**
1684
	 * Is Jetpack active?
1685
	 * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1686
	 *
1687
	 * @return bool
1688
	 */
1689
	public static function is_active() {
1690
		return self::connection()->is_active();
1691
	}
1692
1693
	/**
1694
	 * Make an API call to WordPress.com for plan status
1695
	 *
1696
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1697
	 *
1698
	 * @return bool True if plan is updated, false if no update
1699
	 */
1700
	public static function refresh_active_plan_from_wpcom() {
1701
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1702
		return Jetpack_Plan::refresh_from_wpcom();
1703
	}
1704
1705
	/**
1706
	 * Get the plan that this Jetpack site is currently using
1707
	 *
1708
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1709
	 * @return array Active Jetpack plan details.
1710
	 */
1711
	public static function get_active_plan() {
1712
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1713
		return Jetpack_Plan::get();
1714
	}
1715
1716
	/**
1717
	 * Determine whether the active plan supports a particular feature
1718
	 *
1719
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1720
	 * @return bool True if plan supports feature, false if not.
1721
	 */
1722
	public static function active_plan_supports( $feature ) {
1723
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1724
		return Jetpack_Plan::supports( $feature );
1725
	}
1726
1727
	/**
1728
	 * Deprecated: Is Jetpack in development (offline) mode?
1729
	 *
1730
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1731
	 * and themes still use it, and we do not want to flood them with notices.
1732
	 *
1733
	 * Please use Automattic\Jetpack\Status()->is_offline_mode() instead.
1734
	 *
1735
	 * @deprecated since 8.0.
1736
	 */
1737
	public static function is_development_mode() {
1738
		_deprecated_function( __METHOD__, 'jetpack-8.0', '\Automattic\Jetpack\Status->is_offline_mode' );
1739
		return ( new Status() )->is_offline_mode();
1740
	}
1741
1742
	/**
1743
	 * Whether the site is currently onboarding or not.
1744
	 * A site is considered as being onboarded if it currently has an onboarding token.
1745
	 *
1746
	 * @since 5.8
1747
	 *
1748
	 * @access public
1749
	 * @static
1750
	 *
1751
	 * @return bool True if the site is currently onboarding, false otherwise
1752
	 */
1753
	public static function is_onboarding() {
1754
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1755
	}
1756
1757
	/**
1758
	 * Determines reason for Jetpack offline mode.
1759
	 */
1760
	public static function development_mode_trigger_text() {
1761
		$status = new Status();
1762
1763
		if ( ! $status->is_offline_mode() ) {
1764
			return __( 'Jetpack is not in Offline Mode.', 'jetpack' );
1765
		}
1766
1767
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1768
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1769
		} elseif ( defined( 'WP_LOCAL_DEV' ) && WP_LOCAL_DEV ) {
1770
			$notice = __( 'The WP_LOCAL_DEV constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1771
		} elseif ( $status->is_local_site() ) {
1772
			$notice = __( 'The site URL is a known local development environment URL (e.g. http://localhost).', 'jetpack' );
1773
			/** This filter is documented in packages/status/src/class-status.php */
1774
		} elseif ( has_filter( 'jetpack_development_mode' ) && apply_filters( 'jetpack_development_mode', false ) ) { // This is a deprecated filter name.
1775
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1776
		} else {
1777
			$notice = __( 'The jetpack_offline_mode filter is set to true.', 'jetpack' );
1778
		}
1779
1780
		return $notice;
1781
1782
	}
1783
	/**
1784
	 * Get Jetpack offline mode notice text and notice class.
1785
	 *
1786
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_offline_mode
1787
	 */
1788
	public static function show_development_mode_notice() {
1789 View Code Duplication
		if ( ( new Status() )->is_offline_mode() ) {
1790
			$notice = sprintf(
1791
				/* translators: %s is a URL */
1792
				__( 'In <a href="%s" target="_blank">Offline Mode</a>:', 'jetpack' ),
1793
				Redirect::get_url( 'jetpack-support-development-mode' )
1794
			);
1795
1796
			$notice .= ' ' . self::development_mode_trigger_text();
1797
1798
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1799
		}
1800
1801
		// Throw up a notice if using a development version and as for feedback.
1802
		if ( self::is_development_version() ) {
1803
			/* translators: %s is a URL */
1804
			$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' ) );
1805
1806
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1807
		}
1808
		// Throw up a notice if using staging mode
1809 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1810
			/* translators: %s is a URL */
1811
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1812
1813
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1814
		}
1815
	}
1816
1817
	/**
1818
	 * Whether Jetpack's version maps to a public release, or a development version.
1819
	 */
1820
	public static function is_development_version() {
1821
		/**
1822
		 * Allows filtering whether this is a development version of Jetpack.
1823
		 *
1824
		 * This filter is especially useful for tests.
1825
		 *
1826
		 * @since 4.3.0
1827
		 *
1828
		 * @param bool $development_version Is this a develoment version of Jetpack?
1829
		 */
1830
		return (bool) apply_filters(
1831
			'jetpack_development_version',
1832
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1833
		);
1834
	}
1835
1836
	/**
1837
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1838
	 */
1839
	public static function is_user_connected( $user_id = false ) {
1840
		_deprecated_function( __METHOD__, 'jetpack-9.5', 'Automattic\\Jetpack\\Connection\\Manager\\is_user_connected' );
1841
		return self::connection()->is_user_connected( $user_id );
0 ignored issues
show
Documentation introduced by
$user_id is of type boolean, but the function expects a false|integer.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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