Completed
Push — update/improve-stats-widget ( 108ed5...efa494 )
by Jeremy
60:09 queued 47:39
created

Jetpack::try_registration()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 0
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
<?php
2
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
788
		// Actions for Manager::authorize().
789
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
790
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
791
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
792
793
		add_action( 'jetpack_client_authorize_error', array( Jetpack_Client_Server::class, 'client_authorize_error' ) );
794
		add_filter( 'jetpack_client_authorize_already_authorized_url', array( Jetpack_Client_Server::class, 'client_authorize_already_authorized_url' ) );
795
		add_action( 'jetpack_client_authorize_processing', array( Jetpack_Client_Server::class, 'client_authorize_processing' ) );
796
		add_filter( 'jetpack_client_authorize_fallback_url', array( Jetpack_Client_Server::class, 'client_authorize_fallback_url' ) );
797
798
		// Filters for the Manager::get_token() urls and request body.
799
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
800
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
801
802
		// Actions for successful reconnect.
803
		add_action( 'jetpack_reconnection_completed', array( $this, 'reconnection_completed' ) );
804
805
		// Actions for licensing.
806
		Licensing::instance()->initialize();
807
808
		// Filters for Sync Callables.
809
		add_filter( 'jetpack_sync_callable_whitelist', array( $this, 'filter_sync_callable_whitelist' ), 10, 1 );
810
		add_filter( 'jetpack_sync_multisite_callable_whitelist', array( $this, 'filter_sync_multisite_callable_whitelist' ), 10, 1 );
811
812
		// Make resources use static domain when possible.
813
		add_filter( 'jetpack_static_url', array( 'Automattic\\Jetpack\\Assets', 'staticize_subdomain' ) );
814
815
		// Validate the domain names in Jetpack development versions.
816
		add_action( 'jetpack_pre_register', array( get_called_class(), 'registration_check_domains' ) );
817
	}
818
819
	/**
820
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
821
	 * Config object.
822
	 */
823
	public function configure() {
824
		$config = new Config();
825
826
		foreach (
827
			array(
828
				'sync',
829
				'jitm',
830
			)
831
			as $feature
832
		) {
833
			$config->ensure( $feature );
834
		}
835
836
		$config->ensure(
837
			'connection',
838
			array(
839
				'slug' => 'jetpack',
840
				'name' => 'Jetpack',
841
			)
842
		);
843
844
		if ( ! $this->connection_manager ) {
845
			$this->connection_manager = new Connection_Manager( 'jetpack' );
846
847
			/**
848
			 * Filter to activate Jetpack Connection UI.
849
			 * INTERNAL USE ONLY.
850
			 *
851
			 * @since 9.5.0
852
			 *
853
			 * @param bool false Whether to activate the Connection UI.
854
			 */
855
			if ( apply_filters( 'jetpack_connection_ui_active', false ) ) {
856
				Automattic\Jetpack\ConnectionUI\Admin::init();
857
			}
858
		}
859
860
		/*
861
		 * Load things that should only be in Network Admin.
862
		 *
863
		 * For now blow away everything else until a more full
864
		 * understanding of what is needed at the network level is
865
		 * available
866
		 */
867
		if ( is_multisite() ) {
868
			$network = Jetpack_Network::init();
869
			$network->set_connection( $this->connection_manager );
870
		}
871
872
		if ( self::is_connection_ready() ) {
873
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
874
875
			Jetpack_Heartbeat::init();
876
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
877
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
878
				Jetpack_Search_Performance_Logger::init();
879
			}
880
		}
881
882
		// Initialize remote file upload request handlers.
883
		$this->add_remote_request_handlers();
884
885
		/*
886
		 * Enable enhanced handling of previewing sites in Calypso
887
		 */
888
		if ( self::is_connection_ready() ) {
889
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
890
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
891
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
892
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
893
		}
894
895
		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
new \Automattic\Jetpack\Terms_Of_Service() is of type object<Automattic\Jetpack\Terms_Of_Service>, but the function expects a object<Automattic\Jetpac...tpack\Terms_Of_Service>.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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