Completed
Push — add/e2e-headless-connection ( a68ce4...251964 )
by Yaroslav
10:43
created

Jetpack::admin_init()   B

Complexity

Conditions 11
Paths 24

Size

Total Lines 44

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 11
nc 24
nop 0
dl 0
loc 44
rs 7.3166
c 0
b 0
f 0

How to fix   Complexity   

Long Method

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

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

Commonly applied refactorings include:

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

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

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

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
7523
			return false;
7524
		}
7525
		return true;
7526
	}
7527
7528
	/**
7529
	 * Checks if a Jetpack site is both active and not in offline mode.
7530
	 *
7531
	 * This is a DRY function to avoid repeating `Jetpack::is_connection_ready && ! Automattic\Jetpack\Status->is_offline_mode`.
7532
	 *
7533
	 * @since 8.8.0
7534
	 *
7535
	 * @return bool True if Jetpack is active and not in offline mode.
7536
	 */
7537
	public static function is_active_and_not_offline_mode() {
7538
		if ( ! self::is_connection_ready() || ( new Status() )->is_offline_mode() ) {
7539
			return false;
7540
		}
7541
		return true;
7542
	}
7543
7544
	/**
7545
	 * Returns the list of products that we have available for purchase.
7546
	 */
7547
	public static function get_products_for_purchase() {
7548
		$products = array();
7549
		if ( ! is_multisite() ) {
7550
			$products[] = array(
7551
				'key'               => 'backup',
7552
				'title'             => __( 'Jetpack Backup', 'jetpack' ),
7553
				'short_description' => __( 'Always-on backups ensure you never lose your site.', 'jetpack' ),
7554
				'learn_more'        => __( 'Which backup option is best for me?', 'jetpack' ),
7555
				'description'       => __( 'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.', 'jetpack' ),
7556
				'options_label'     => __( 'Select a backup option:', 'jetpack' ),
7557
				'options'           => array(
7558
					array(
7559
						'type'        => 'daily',
7560
						'slug'        => 'jetpack-backup-daily',
7561
						'key'         => 'jetpack_backup_daily',
7562
						'name'        => __( 'Daily Backups', 'jetpack' ),
7563
						'description' => __( 'Your data is being securely backed up daily.', 'jetpack' ),
7564
					),
7565
					array(
7566
						'type'        => 'realtime',
7567
						'slug'        => 'jetpack-backup-realtime',
7568
						'key'         => 'jetpack_backup_realtime',
7569
						'name'        => __( 'Real-Time Backups', 'jetpack' ),
7570
						'description' => __( 'Your data is being securely backed up as you edit.', 'jetpack' ),
7571
					),
7572
				),
7573
				'default_option'    => 'realtime',
7574
				'show_promotion'    => true,
7575
				'discount_percent'  => 70,
7576
				'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'daily-backup-plan', 'realtime-backup-plan' ),
7577
			);
7578
7579
			$products[] = array(
7580
				'key'               => 'scan',
7581
				'title'             => __( 'Jetpack Scan', 'jetpack' ),
7582
				'short_description' => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7583
				'learn_more'        => __( 'Learn More', 'jetpack' ),
7584
				'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7585
				'show_promotion'    => true,
7586
				'discount_percent'  => 30,
7587
				'options'           => array(
7588
					array(
7589
						'type' => 'scan',
7590
						'slug' => 'jetpack-scan',
7591
						'key'  => 'jetpack_scan',
7592
						'name' => __( 'Daily Scan', 'jetpack' ),
7593
					),
7594
				),
7595
				'default_option'    => 'scan',
7596
				'included_in_plans' => array( 'premium-plan', 'business-plan', 'scan-plan' ),
7597
			);
7598
		}
7599
7600
		$products[] = array(
7601
			'key'               => 'search',
7602
			'title'             => __( 'Jetpack Search', 'jetpack' ),
7603
			'short_description' => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7604
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7605
			'description'       => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7606
			'label_popup'       => __( 'Records are all posts, pages, custom post types, and other types of content indexed by Jetpack Search.', 'jetpack' ),
7607
			'options'           => array(
7608
				array(
7609
					'type' => 'search',
7610
					'slug' => 'jetpack-search',
7611
					'key'  => 'jetpack_search',
7612
					'name' => __( 'Search', 'jetpack' ),
7613
				),
7614
			),
7615
			'tears'             => array(),
7616
			'default_option'    => 'search',
7617
			'show_promotion'    => false,
7618
			'included_in_plans' => array( 'search-plan' ),
7619
		);
7620
7621
		$products[] = array(
7622
			'key'               => 'anti-spam',
7623
			'title'             => __( 'Jetpack Anti-Spam', 'jetpack' ),
7624
			'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' ),
7625
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7626
			'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' ),
7627
			'options'           => array(
7628
				array(
7629
					'type' => 'anti-spam',
7630
					'slug' => 'jetpack-anti-spam',
7631
					'key'  => 'jetpack_anti_spam',
7632
					'name' => __( 'Anti-Spam', 'jetpack' ),
7633
				),
7634
			),
7635
			'default_option'    => 'anti-spam',
7636
			'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'anti-spam-plan' ),
7637
		);
7638
7639
		return $products;
7640
	}
7641
}
7642