Completed
Push — update/update_modal_block_styl... ( 4105b3...70668b )
by
unknown
11:32
created

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