Completed
Push — fix/mailchimp-styling-for-fse ( ea89d1...c645b0 )
by
unknown
20:37 queued 09:41
created

Jetpack::try_registration()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 0
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
<?php
2
3
use Automattic\Jetpack\Assets;
4
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
5
use Automattic\Jetpack\Config;
6
use Automattic\Jetpack\Connection\Client;
7
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
8
use Automattic\Jetpack\Connection\Nonce_Handler;
9
use Automattic\Jetpack\Connection\Plugin_Storage as Connection_Plugin_Storage;
10
use Automattic\Jetpack\Connection\Rest_Authentication as Connection_Rest_Authentication;
11
use Automattic\Jetpack\Connection\Secrets;
12
use Automattic\Jetpack\Connection\Tokens;
13
use Automattic\Jetpack\Connection\Utils as Connection_Utils;
14
use Automattic\Jetpack\Connection\Webhooks as Connection_Webhooks;
15
use Automattic\Jetpack\Constants;
16
use Automattic\Jetpack\Device_Detection\User_Agent_Info;
17
use Automattic\Jetpack\Licensing;
18
use Automattic\Jetpack\Partner;
19
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
20
use Automattic\Jetpack\Redirect;
21
use Automattic\Jetpack\Status;
22
use Automattic\Jetpack\Sync\Functions;
23
use Automattic\Jetpack\Sync\Health;
24
use Automattic\Jetpack\Sync\Sender;
25
use Automattic\Jetpack\Sync\Users;
26
use Automattic\Jetpack\Terms_Of_Service;
27
use Automattic\Jetpack\Tracking;
28
29
/*
30
Options:
31
jetpack_options (array)
32
	An array of options.
33
	@see Jetpack_Options::get_option_names()
34
35
jetpack_register (string)
36
	Temporary verification secrets.
37
38
jetpack_activated (int)
39
	1: the plugin was activated normally
40
	2: the plugin was activated on this site because of a network-wide activation
41
	3: the plugin was auto-installed
42
	4: the plugin was manually disconnected (but is still installed)
43
44
jetpack_active_modules (array)
45
	Array of active module slugs.
46
47
jetpack_do_activate (bool)
48
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
49
*/
50
51
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
52
53
class Jetpack {
54
	public $xmlrpc_server = null;
55
56
	/**
57
	 * @var array The handles of styles that are concatenated into jetpack.css.
58
	 *
59
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
60
	 */
61
	public $concatenated_style_handles = array(
62
		'jetpack-carousel',
63
		'grunion.css',
64
		'the-neverending-homepage',
65
		'jetpack_likes',
66
		'jetpack_related-posts',
67
		'sharedaddy',
68
		'jetpack-slideshow',
69
		'presentations',
70
		'quiz',
71
		'jetpack-subscriptions',
72
		'jetpack-responsive-videos-style',
73
		'jetpack-social-menu',
74
		'tiled-gallery',
75
		'jetpack_display_posts_widget',
76
		'gravatar-profile-widget',
77
		'goodreads-widget',
78
		'jetpack_social_media_icons_widget',
79
		'jetpack-top-posts-widget',
80
		'jetpack_image_widget',
81
		'jetpack-my-community-widget',
82
		'jetpack-authors-widget',
83
		'wordads',
84
		'eu-cookie-law-style',
85
		'flickr-widget-style',
86
		'jetpack-search-widget',
87
		'jetpack-simple-payments-widget-style',
88
		'jetpack-widget-social-icons-styles',
89
		'wpcom_instagram_widget',
90
	);
91
92
	/**
93
	 * Contains all assets that have had their URL rewritten to minified versions.
94
	 *
95
	 * @var array
96
	 */
97
	static $min_assets = array();
98
99
	public $plugins_to_deactivate = array(
100
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
101
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
102
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
103
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
104
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
105
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
106
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
107
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
108
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
109
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
110
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
111
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
112
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
113
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
114
	);
115
116
	/**
117
	 * Map of roles we care about, and their corresponding minimum capabilities.
118
	 *
119
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
120
	 *
121
	 * @access public
122
	 * @static
123
	 *
124
	 * @var array
125
	 */
126
	public static $capability_translations = array(
127
		'administrator' => 'manage_options',
128
		'editor'        => 'edit_others_posts',
129
		'author'        => 'publish_posts',
130
		'contributor'   => 'edit_posts',
131
		'subscriber'    => 'read',
132
	);
133
134
	/**
135
	 * Map of modules that have conflicts with plugins and should not be auto-activated
136
	 * if the plugins are active.  Used by filter_default_modules
137
	 *
138
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
139
	 * change `module-slug` and add this to your plugin:
140
	 *
141
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
142
	 * function my_jetpack_get_default_modules( $modules ) {
143
	 *     return array_diff( $modules, array( 'module-slug' ) );
144
	 * }
145
	 *
146
	 * @var array
147
	 */
148
	private $conflicting_plugins = array(
149
		'comments'           => array(
150
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
151
			'Disqus'                         => 'disqus-comment-system/disqus.php',
152
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
153
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
154
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
155
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
156
		),
157
		'comment-likes'      => array(
158
			'Epoch' => 'epoch/plugincore.php',
159
		),
160
		'contact-form'       => array(
161
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
162
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
163
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
164
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
165
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
166
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
167
		),
168
		'latex'              => array(
169
			'LaTeX for WordPress'     => 'latex/latex.php',
170
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
171
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
172
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
173
			'Enable Latex'            => 'enable-latex/enable-latex.php',
174
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
175
		),
176
		'protect'            => array(
177
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
178
			'Captcha'                           => 'captcha/captcha.php',
179
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
180
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
181
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
182
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
183
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
184
			'Security-protection'               => 'security-protection/security-protection.php',
185
			'Login Security'                    => 'login-security/login-security.php',
186
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
187
			'Wordfence Security'                => 'wordfence/wordfence.php',
188
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
189
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
190
		),
191
		'random-redirect'    => array(
192
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
193
		),
194
		'related-posts'      => array(
195
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
196
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
197
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
198
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
199
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
200
			'outbrain'                    => 'outbrain/outbrain.php',
201
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
202
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
203
		),
204
		'sharedaddy'         => array(
205
			'AddThis'     => 'addthis/addthis_social_widget.php',
206
			'Add To Any'  => 'add-to-any/add-to-any.php',
207
			'ShareThis'   => 'share-this/sharethis.php',
208
			'Shareaholic' => 'shareaholic/shareaholic.php',
209
		),
210
		'seo-tools'          => array(
211
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
212
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
213
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
214
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
215
			'The SEO Framework'              => 'autodescription/autodescription.php',
216
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
217
			'Slim SEO'                       => 'slim-seo/slim-seo.php',
218
		),
219
		'verification-tools' => array(
220
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
221
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
222
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
223
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
224
			'The SEO Framework'              => 'autodescription/autodescription.php',
225
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
226
			'Slim SEO'                       => 'slim-seo/slim-seo.php',
227
		),
228
		'widget-visibility'  => array(
229
			'Widget Logic'    => 'widget-logic/widget_logic.php',
230
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
231
		),
232
		'sitemaps'           => array(
233
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
234
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
235
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
236
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
237
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
238
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
239
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
240
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
241
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
242
			'The SEO Framework'                    => 'autodescription/autodescription.php',
243
			'Sitemap'                              => 'sitemap/sitemap.php',
244
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
245
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
246
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
247
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
248
			'Rank Math'                            => 'seo-by-rank-math/rank-math.php',
249
			'Slim SEO'                             => 'slim-seo/slim-seo.php',
250
		),
251
		'lazy-images'        => array(
252
			'Lazy Load'              => 'lazy-load/lazy-load.php',
253
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
254
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
255
		),
256
	);
257
258
	/**
259
	 * Plugins for which we turn off our Facebook OG Tags implementation.
260
	 *
261
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
262
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
263
	 *
264
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
265
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
266
	 */
267
	private $open_graph_conflicting_plugins = array(
268
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
269
		// 2 Click Social Media Buttons
270
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
271
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
272
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
273
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
274
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
275
		// Open Graph Meta Tags by Heateor
276
		'facebook/facebook.php',                                 // Facebook (official plugin)
277
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
278
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
279
		// Facebook Featured Image & OG Meta Tags
280
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
281
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
282
		// Facebook Open Graph Meta Tags for WordPress
283
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
284
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
285
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
286
		// Fedmich's Facebook Open Graph Meta
287
		'network-publisher/networkpub.php',                      // Network Publisher
288
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
289
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
290
		// NextScripts SNAP
291
		'og-tags/og-tags.php',                                   // OG Tags
292
		'opengraph/opengraph.php',                               // Open Graph
293
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
294
		// Open Graph Protocol Framework
295
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
296
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
297
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
298
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
299
		'sharepress/sharepress.php',                             // SharePress
300
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
301
		'social-discussions/social-discussions.php',             // Social Discussions
302
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
303
		'socialize/socialize.php',                               // Socialize
304
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
305
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
306
		// Tweet, Like, Google +1 and Share
307
		'wordbooker/wordbooker.php',                             // Wordbooker
308
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
309
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
310
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
311
		// WP Facebook Like Send & Open Graph Meta
312
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
313
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
314
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
315
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
316
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
317
		'seo-by-rank-math/rank-math.php',                        // Rank Math.
318
		'slim-seo/slim-seo.php',                                 // Slim SEO
319
	);
320
321
	/**
322
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
323
	 */
324
	private $twitter_cards_conflicting_plugins = array(
325
		// 'twitter/twitter.php',                       // The official one handles this on its own.
326
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
327
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
328
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
329
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
330
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
331
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
332
		'twitter-cards/twitter-cards.php',           // Twitter Cards
333
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
334
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
335
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
336
		'seo-by-rank-math/rank-math.php',            // Rank Math.
337
		'slim-seo/slim-seo.php',                     // Slim SEO
338
	);
339
340
	/**
341
	 * Message to display in admin_notice
342
	 *
343
	 * @var string
344
	 */
345
	public $message = '';
346
347
	/**
348
	 * Error to display in admin_notice
349
	 *
350
	 * @var string
351
	 */
352
	public $error = '';
353
354
	/**
355
	 * Modules that need more privacy description.
356
	 *
357
	 * @var string
358
	 */
359
	public $privacy_checks = '';
360
361
	/**
362
	 * Stats to record once the page loads
363
	 *
364
	 * @var array
365
	 */
366
	public $stats = array();
367
368
	/**
369
	 * Jetpack_Sync object
370
	 */
371
	public $sync;
372
373
	/**
374
	 * Verified data for JSON authorization request
375
	 */
376
	public $json_api_authorization_request = array();
377
378
	/**
379
	 * @var Automattic\Jetpack\Connection\Manager
380
	 */
381
	protected $connection_manager;
382
383
	/**
384
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
385
	 */
386
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
387
388
	/**
389
	 * Holds an instance of Automattic\Jetpack\A8c_Mc_Stats
390
	 *
391
	 * @var Automattic\Jetpack\A8c_Mc_Stats
392
	 */
393
	public $a8c_mc_stats_instance;
394
395
	/**
396
	 * Constant for login redirect key.
397
	 *
398
	 * @var string
399
	 * @since 8.4.0
400
	 */
401
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
402
403
	/**
404
	 * Holds the singleton instance of this class
405
	 *
406
	 * @since 2.3.3
407
	 * @var Jetpack
408
	 */
409
	static $instance = false;
410
411
	/**
412
	 * Singleton
413
	 *
414
	 * @static
415
	 */
416
	public static function init() {
417
		if ( ! self::$instance ) {
418
			self::$instance = new Jetpack();
419
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
420
		}
421
422
		return self::$instance;
423
	}
424
425
	/**
426
	 * Must never be called statically
427
	 */
428
	function plugin_upgrade() {
429
		if ( self::is_connection_ready() ) {
430
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
431
			if ( JETPACK__VERSION != $version ) {
432
				// Prevent multiple upgrades at once - only a single process should trigger
433
				// an upgrade to avoid stampedes
434
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
435
					return;
436
				}
437
438
				// Set a short lock to prevent multiple instances of the upgrade
439
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
440
441
				// check which active modules actually exist and remove others from active_modules list
442
				$unfiltered_modules = self::get_active_modules();
443
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
444
				if ( array_diff( $unfiltered_modules, $modules ) ) {
445
					self::update_active_modules( $modules );
446
				}
447
448
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
449
450
				// Upgrade to 4.3.0
451
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
452
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
453
				}
454
455
				// Make sure Markdown for posts gets turned back on
456
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
457
					update_option( 'wpcom_publish_posts_with_markdown', true );
458
				}
459
460
				/*
461
				 * Minileven deprecation. 8.3.0.
462
				 * Only delete options if not using
463
				 * the replacement standalone Minileven plugin.
464
				 */
465
				if (
466
					! self::is_plugin_active( 'minileven-master/minileven.php' )
467
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
468
				) {
469
					if ( get_option( 'wp_mobile_custom_css' ) ) {
470
						delete_option( 'wp_mobile_custom_css' );
471
					}
472
					if ( get_option( 'wp_mobile_excerpt' ) ) {
473
						delete_option( 'wp_mobile_excerpt' );
474
					}
475
					if ( get_option( 'wp_mobile_featured_images' ) ) {
476
						delete_option( 'wp_mobile_featured_images' );
477
					}
478
					if ( get_option( 'wp_mobile_app_promos' ) ) {
479
						delete_option( 'wp_mobile_app_promos' );
480
					}
481
				}
482
483
				// Upgrade to 8.4.0.
484
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
485
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
486
				}
487
488
				// Update to 8.8.x (WordPress 5.5 Compatibility).
489
				if ( Jetpack_Options::get_option( 'autoupdate_plugins' ) ) {
490
					$updated = update_site_option(
491
						'auto_update_plugins',
492
						array_unique(
493
							array_merge(
494
								(array) Jetpack_Options::get_option( 'autoupdate_plugins', array() ),
495
								(array) get_site_option( 'auto_update_plugins', array() )
496
							)
497
						)
498
					);
499
500
					if ( $updated ) {
501
						Jetpack_Options::delete_option( 'autoupdate_plugins' );
502
					} // Should we have some type of fallback if something fails here?
503
				}
504
505
				if ( did_action( 'wp_loaded' ) ) {
506
					self::upgrade_on_load();
507
				} else {
508
					add_action(
509
						'wp_loaded',
510
						array( __CLASS__, 'upgrade_on_load' )
511
					);
512
				}
513
			}
514
		}
515
	}
516
517
	/**
518
	 * Runs upgrade routines that need to have modules loaded.
519
	 */
520
	static function upgrade_on_load() {
521
522
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
523
		// This can happen in case Jetpack has been just upgraded and is
524
		// being initialized late during the page load. In this case we wait
525
		// until the next proper admin page load with Jetpack active.
526
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
527
			delete_transient( self::$plugin_upgrade_lock_key );
528
529
			return;
530
		}
531
532
		self::maybe_set_version_option();
533
534
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
535
			Jetpack_Widget_Conditions::migrate_post_type_rules();
536
		}
537
538
		if (
539
			class_exists( 'Jetpack_Sitemap_Manager' )
540
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
541
		) {
542
			do_action( 'jetpack_sitemaps_purge_data' );
543
		}
544
545
		// Delete old stats cache
546
		delete_option( 'jetpack_restapi_stats_cache' );
547
548
		delete_transient( self::$plugin_upgrade_lock_key );
549
	}
550
551
	/**
552
	 * Saves all the currently active modules to options.
553
	 * Also fires Action hooks for each newly activated and deactivated module.
554
	 *
555
	 * @param $modules Array Array of active modules to be saved in options.
556
	 *
557
	 * @return $success bool true for success, false for failure.
0 ignored issues
show
Documentation introduced by
The doc-type $success could not be parsed: Unknown type name "$success" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
558
	 */
559
	static function update_active_modules( $modules ) {
560
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
561
		$active_modules       = self::get_active_modules();
562
		$new_active_modules   = array_diff( $modules, $current_modules );
563
		$new_inactive_modules = array_diff( $active_modules, $modules );
564
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
565
		$reindexed_modules    = array_values( $new_current_modules );
566
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
567
568
		foreach ( $new_active_modules as $module ) {
569
			/**
570
			 * Fires when a specific module is activated.
571
			 *
572
			 * @since 1.9.0
573
			 *
574
			 * @param string $module Module slug.
575
			 * @param boolean $success whether the module was activated. @since 4.2
576
			 */
577
			do_action( 'jetpack_activate_module', $module, $success );
578
			/**
579
			 * Fires when a module is activated.
580
			 * The dynamic part of the filter, $module, is the module slug.
581
			 *
582
			 * @since 1.9.0
583
			 *
584
			 * @param string $module Module slug.
585
			 */
586
			do_action( "jetpack_activate_module_$module", $module );
587
		}
588
589
		foreach ( $new_inactive_modules as $module ) {
590
			/**
591
			 * Fired after a module has been deactivated.
592
			 *
593
			 * @since 4.2.0
594
			 *
595
			 * @param string $module Module slug.
596
			 * @param boolean $success whether the module was deactivated.
597
			 */
598
			do_action( 'jetpack_deactivate_module', $module, $success );
599
			/**
600
			 * Fires when a module is deactivated.
601
			 * The dynamic part of the filter, $module, is the module slug.
602
			 *
603
			 * @since 1.9.0
604
			 *
605
			 * @param string $module Module slug.
606
			 */
607
			do_action( "jetpack_deactivate_module_$module", $module );
608
		}
609
610
		return $success;
611
	}
612
613
	static function delete_active_modules() {
614
		self::update_active_modules( array() );
615
	}
616
617
	/**
618
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
619
	 * available.
620
	 */
621
	public function add_configure_hook() {
622
		global $wp_filter;
623
624
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
625
		if ( false !== $current_priority ) {
626
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
627
		}
628
629
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
630
		sort( $taken_priorities );
631
632
		$first_priority = array_shift( $taken_priorities );
633
634
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
635
			$new_priority = - PHP_INT_MAX;
636
		} else {
637
			$new_priority = $first_priority - 1;
638
		}
639
640
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
641
	}
642
643
	/**
644
	 * Constructor.  Initializes WordPress hooks
645
	 */
646
	private function __construct() {
647
		/*
648
		 * Check for and alert any deprecated hooks
649
		 */
650
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
651
652
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
653
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
654
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
655
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
656
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
657
658
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
659
660
		add_filter(
661
			'jetpack_signature_check_token',
662
			array( __CLASS__, 'verify_onboarding_token' ),
663
			10,
664
			3
665
		);
666
667
		/**
668
		 * Prepare Gutenberg Editor functionality
669
		 */
670
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
671
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
672
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
673
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_extended_blocks' ), 9 );
674
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
675
676
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
677
678
		// Unlink user before deleting the user from WP.com.
679
		add_action( 'deleted_user', array( $this, 'disconnect_user' ), 10, 1 );
680
		add_action( 'remove_user_from_blog', array( $this, 'disconnect_user' ), 10, 1 );
681
682
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
683
684
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
685
		add_action( 'login_init', array( $this, 'login_init' ) );
686
687
		// Set up the REST authentication hooks.
688
		Connection_Rest_Authentication::init();
689
690
		add_action( 'admin_init', array( $this, 'admin_init' ) );
691
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
692
693
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
694
695
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
696
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
697
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
698
699
		// returns HTTPS support status
700
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
701
702
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
703
704
		add_action( 'wp_ajax_jetpack_recommendations_banner', array( 'Jetpack_Recommendations_Banner', 'ajax_callback' ) );
705
706
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
707
708
		/**
709
		 * These actions run checks to load additional files.
710
		 * They check for external files or plugins, so they need to run as late as possible.
711
		 */
712
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
713
		add_action( 'web_stories_story_head', array( $this, 'check_open_graph' ), 1 );
714
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
715
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
716
717
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
718
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
719
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
720
721
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
722
723
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
724
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
725
726
		// A filter to control all just in time messages
727
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
728
729
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
730
731
		require_once JETPACK__PLUGIN_DIR . 'class-jetpack-pre-connection-jitms.php';
732
		$jetpack_jitm_messages = ( new Jetpack_Pre_Connection_JITMs() );
733
		add_filter( 'jetpack_pre_connection_jitms', array( $jetpack_jitm_messages, 'add_pre_connection_jitms' ) );
734
735
		/*
736
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
737
		 * We should make sure to only do this for front end links.
738
		 */
739
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
740
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
741
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
742
743
			/*
744
			 * We'll shortcircuit wp_notify_postauthor and wp_notify_moderator pluggable functions
745
			 * so they point moderation links on emails to Calypso.
746
			 */
747
			jetpack_require_lib( 'functions.wp-notify' );
748
			add_filter( 'comment_notification_recipients', 'jetpack_notify_postauthor', 1, 2 );
749
			add_filter( 'notify_moderator', 'jetpack_notify_moderator', 1, 2 );
750
		}
751
752
		add_action(
753
			'plugins_loaded',
754
			function () {
755
				if ( User_Agent_Info::is_mobile_app() ) {
756
					add_filter( 'get_edit_post_link', '__return_empty_string' );
757
				}
758
			}
759
		);
760
761
		// Update the site's Jetpack plan and products from API on heartbeats.
762
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
763
764
		/**
765
		 * This is the hack to concatenate all css files into one.
766
		 * For description and reasoning see the implode_frontend_css method.
767
		 *
768
		 * Super late priority so we catch all the registered styles.
769
		 */
770
		if ( ! is_admin() ) {
771
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
772
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
773
		}
774
775
		/**
776
		 * These are sync actions that we need to keep track of for jitms
777
		 */
778
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
779
780
		// Actually push the stats on shutdown.
781
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
782
			add_action( 'shutdown', array( $this, 'push_stats' ) );
783
		}
784
785
		// After a successful connection.
786
		add_action( 'jetpack_site_registered', array( $this, 'activate_default_modules_on_site_register' ) );
787
		add_action( 'jetpack_site_registered', array( $this, 'handle_unique_registrations_stats' ) );
788
789
		// Actions for Manager::authorize().
790
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
791
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
792
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
793
794
		add_action( 'jetpack_client_authorize_error', array( Jetpack_Client_Server::class, 'client_authorize_error' ) );
795
		add_filter( 'jetpack_client_authorize_already_authorized_url', array( Jetpack_Client_Server::class, 'client_authorize_already_authorized_url' ) );
796
		add_action( 'jetpack_client_authorize_processing', array( Jetpack_Client_Server::class, 'client_authorize_processing' ) );
797
		add_filter( 'jetpack_client_authorize_fallback_url', array( Jetpack_Client_Server::class, 'client_authorize_fallback_url' ) );
798
799
		// Filters for the Manager::get_token() urls and request body.
800
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
801
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
802
803
		// Actions for successful reconnect.
804
		add_action( 'jetpack_reconnection_completed', array( $this, 'reconnection_completed' ) );
805
806
		// Actions for licensing.
807
		Licensing::instance()->initialize();
808
809
		// Filters for Sync Callables.
810
		add_filter( 'jetpack_sync_callable_whitelist', array( $this, 'filter_sync_callable_whitelist' ), 10, 1 );
811
		add_filter( 'jetpack_sync_multisite_callable_whitelist', array( $this, 'filter_sync_multisite_callable_whitelist' ), 10, 1 );
812
813
		// Make resources use static domain when possible.
814
		add_filter( 'jetpack_static_url', array( 'Automattic\\Jetpack\\Assets', 'staticize_subdomain' ) );
815
816
		// Validate the domain names in Jetpack development versions.
817
		add_action( 'jetpack_pre_register', array( get_called_class(), 'registration_check_domains' ) );
818
	}
819
820
	/**
821
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
822
	 * Config object.
823
	 */
824
	public function configure() {
825
		$config = new Config();
826
827
		foreach (
828
			array(
829
				'sync',
830
				'jitm',
831
			)
832
			as $feature
833
		) {
834
			$config->ensure( $feature );
835
		}
836
837
		$config->ensure(
838
			'connection',
839
			array(
840
				'slug' => 'jetpack',
841
				'name' => 'Jetpack',
842
			)
843
		);
844
845
		if ( ! $this->connection_manager ) {
846
			$this->connection_manager = new Connection_Manager( 'jetpack' );
847
848
			/**
849
			 * Filter to activate Jetpack Connection UI.
850
			 * INTERNAL USE ONLY.
851
			 *
852
			 * @since 9.5.0
853
			 *
854
			 * @param bool false Whether to activate the Connection UI.
855
			 */
856
			if ( apply_filters( 'jetpack_connection_ui_active', false ) ) {
857
				Automattic\Jetpack\ConnectionUI\Admin::init();
858
			}
859
		}
860
861
		/*
862
		 * Load things that should only be in Network Admin.
863
		 *
864
		 * For now blow away everything else until a more full
865
		 * understanding of what is needed at the network level is
866
		 * available
867
		 */
868
		if ( is_multisite() ) {
869
			$network = Jetpack_Network::init();
870
			$network->set_connection( $this->connection_manager );
871
		}
872
873
		if ( self::is_connection_ready() ) {
874
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
875
876
			Jetpack_Heartbeat::init();
877
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
878
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
879
				Jetpack_Search_Performance_Logger::init();
880
			}
881
		}
882
883
		// Initialize remote file upload request handlers.
884
		$this->add_remote_request_handlers();
885
886
		/*
887
		 * Enable enhanced handling of previewing sites in Calypso
888
		 */
889
		if ( self::is_connection_ready() ) {
890
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
891
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
892
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
893
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
894
		}
895
896
		if ( ( new Tracking( $this->connection_manager ) )->should_enable_tracking( new Terms_Of_Service(), new Status() ) ) {
0 ignored issues
show
Documentation introduced by
new \Automattic\Jetpack\Status() is of type object<Automattic\Jetpack\Status>, but the function expects a object<Automattic\Jetpac...omattic\Jetpack\Status>.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
Documentation introduced by
$this->connection_manager is of type object<Automattic\Jetpack\Connection\Manager>, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
Documentation introduced by
new \Automattic\Jetpack\Terms_Of_Service() is of type object<Automattic\Jetpack\Terms_Of_Service>, but the function expects a object<Automattic\Jetpac...tpack\Terms_Of_Service>.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
897
			add_action( 'init', array( new Plugin_Tracking(), 'init' ) );
898
		} else {
899
			/**
900
			 * Initialize tracking right after the user agrees to the terms of service.
901
			 */
902
			add_action( 'jetpack_agreed_to_terms_of_service', array( new Plugin_Tracking(), 'init' ) );
903
		}
904
	}
905
906
	/**
907
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
908
	 * initialization code.
909
	 *
910
	 * @action plugins_loaded
911
	 */
912
	public function late_initialization() {
913
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
914
915
		Partner::init();
916
917
		/**
918
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
919
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
920
		 *
921
		 * @since 8.1.0
922
		 *
923
		 * @param Jetpack $jetpack the main plugin class object.
924
		 */
925
		do_action( 'jetpack_loaded', $this );
926
927
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
928
	}
929
930
	/**
931
	 * Sets up the XMLRPC request handlers.
932
	 *
933
	 * @deprecated since 7.7.0
934
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
935
	 *
936
	 * @param array                 $request_params Incoming request parameters.
937
	 * @param Boolean               $is_active      Whether the connection is currently active.
938
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
939
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $xmlrpc_server not be null|Jetpack_XMLRPC_Server?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
940
	 */
941 View Code Duplication
	public function setup_xmlrpc_handlers(
942
		$request_params,
943
		$is_active,
944
		$is_signed,
945
		Jetpack_XMLRPC_Server $xmlrpc_server = null
946
	) {
947
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
948
949
		if ( ! $this->connection_manager ) {
950
			$this->connection_manager = new Connection_Manager();
951
		}
952
953
		return $this->connection_manager->setup_xmlrpc_handlers(
954
			$request_params,
955
			$is_active,
956
			$is_signed,
957
			$xmlrpc_server
958
		);
959
	}
960
961
	/**
962
	 * Initialize REST API registration connector.
963
	 *
964
	 * @deprecated since 7.7.0
965
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
966
	 */
967 View Code Duplication
	public function initialize_rest_api_registration_connector() {
968
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
969
970
		if ( ! $this->connection_manager ) {
971
			$this->connection_manager = new Connection_Manager();
972
		}
973
974
		$this->connection_manager->initialize_rest_api_registration_connector();
975
	}
976
977
	/**
978
	 * This is ported over from the manage module, which has been deprecated and baked in here.
979
	 *
980
	 * @param $domains
981
	 */
982
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
983
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
984
	}
985
986
	/**
987
	 * Return $domains, with 'wordpress.com' appended.
988
	 * This is ported over from the manage module, which has been deprecated and baked in here.
989
	 *
990
	 * @param $domains
991
	 * @return array
992
	 */
993
	function allow_wpcom_domain( $domains ) {
994
		if ( empty( $domains ) ) {
995
			$domains = array();
996
		}
997
		$domains[] = 'wordpress.com';
998
		return array_unique( $domains );
999
	}
1000
1001
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
1002
		$post = get_post( $post_id );
1003
1004
		if ( empty( $post ) ) {
1005
			return $default_url;
1006
		}
1007
1008
		$post_type = $post->post_type;
1009
1010
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
1011
		// https://en.support.wordpress.com/custom-post-types/
1012
		$allowed_post_types = array(
1013
			'post',
1014
			'page',
1015
			'jetpack-portfolio',
1016
			'jetpack-testimonial',
1017
		);
1018
1019
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
1020
			return $default_url;
1021
		}
1022
1023
		return Redirect::get_url(
1024
			'calypso-edit-' . $post_type,
1025
			array(
1026
				'path' => $post_id,
1027
			)
1028
		);
1029
	}
1030
1031
	function point_edit_comment_links_to_calypso( $url ) {
1032
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
1033
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
1034
1035
		return Redirect::get_url(
1036
			'calypso-edit-comment',
1037
			array(
1038
				'path' => $query_args['amp;c'],
1039
			)
1040
		);
1041
1042
	}
1043
1044
	/**
1045
	 * Extend Sync callables with Jetpack Plugin functions.
1046
	 *
1047
	 * @param array $callables list of callables.
1048
	 *
1049
	 * @return array list of callables.
1050
	 */
1051
	public function filter_sync_callable_whitelist( $callables ) {
1052
1053
		// Jetpack Functions.
1054
		$jetpack_callables = array(
1055
			'single_user_site'         => array( 'Jetpack', 'is_single_user_site' ),
1056
			'updates'                  => array( 'Jetpack', 'get_updates' ),
1057
			'active_modules'           => array( 'Jetpack', 'get_active_modules' ),
1058
			'available_jetpack_blocks' => array( 'Jetpack_Gutenberg', 'get_availability' ), // Includes both Gutenberg blocks *and* plugins.
1059
		);
1060
		$callables         = array_merge( $callables, $jetpack_callables );
1061
1062
		// Jetpack_SSO_Helpers.
1063
		if ( include_once JETPACK__PLUGIN_DIR . 'modules/sso/class.jetpack-sso-helpers.php' ) {
1064
			$sso_helpers = array(
1065
				'sso_is_two_step_required'      => array( 'Jetpack_SSO_Helpers', 'is_two_step_required' ),
1066
				'sso_should_hide_login_form'    => array( 'Jetpack_SSO_Helpers', 'should_hide_login_form' ),
1067
				'sso_match_by_email'            => array( 'Jetpack_SSO_Helpers', 'match_by_email' ),
1068
				'sso_new_user_override'         => array( 'Jetpack_SSO_Helpers', 'new_user_override' ),
1069
				'sso_bypass_default_login_form' => array( 'Jetpack_SSO_Helpers', 'bypass_login_forward_wpcom' ),
1070
			);
1071
			$callables   = array_merge( $callables, $sso_helpers );
1072
		}
1073
1074
		return $callables;
1075
	}
1076
1077
	/**
1078
	 * Extend Sync multisite callables with Jetpack Plugin functions.
1079
	 *
1080
	 * @param array $callables list of callables.
1081
	 *
1082
	 * @return array list of callables.
1083
	 */
1084
	public function filter_sync_multisite_callable_whitelist( $callables ) {
1085
1086
		// Jetpack Funtions.
1087
		$jetpack_multisite_callables = array(
1088
			'network_name'                        => array( 'Jetpack', 'network_name' ),
1089
			'network_allow_new_registrations'     => array( 'Jetpack', 'network_allow_new_registrations' ),
1090
			'network_add_new_users'               => array( 'Jetpack', 'network_add_new_users' ),
1091
			'network_site_upload_space'           => array( 'Jetpack', 'network_site_upload_space' ),
1092
			'network_upload_file_types'           => array( 'Jetpack', 'network_upload_file_types' ),
1093
			'network_enable_administration_menus' => array( 'Jetpack', 'network_enable_administration_menus' ),
1094
		);
1095
		$callables                   = array_merge( $callables, $jetpack_multisite_callables );
1096
1097
		return $callables;
1098
	}
1099
1100
	function jetpack_track_last_sync_callback( $params ) {
1101
		/**
1102
		 * Filter to turn off jitm caching
1103
		 *
1104
		 * @since 5.4.0
1105
		 *
1106
		 * @param bool false Whether to cache just in time messages
1107
		 */
1108
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
1109
			return $params;
1110
		}
1111
1112
		if ( is_array( $params ) && isset( $params[0] ) ) {
1113
			$option = $params[0];
1114
			if ( 'active_plugins' === $option ) {
1115
				// use the cache if we can, but not terribly important if it gets evicted
1116
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
1117
			}
1118
		}
1119
1120
		return $params;
1121
	}
1122
1123
	function jetpack_connection_banner_callback() {
1124
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
1125
1126
		// Disable the banner dismiss functionality if the pre-connection prompt helpers filter is set.
1127
		if (
1128
			isset( $_REQUEST['dismissBanner'] ) &&
1129
			! Jetpack_Connection_Banner::force_display()
1130
		) {
1131
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
1132
			wp_send_json_success();
1133
		}
1134
1135
		wp_die();
1136
	}
1137
1138
	/**
1139
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1140
	 * Only used in our alternate XML-RPC endpoint, where we want to
1141
	 * ensure that Core and other plugins' methods are not exposed.
1142
	 *
1143
	 * @deprecated since 7.7.0
1144
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1145
	 *
1146
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1147
	 * @return array Filtered $methods
1148
	 */
1149 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1150
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1151
1152
		if ( ! $this->connection_manager ) {
1153
			$this->connection_manager = new Connection_Manager();
1154
		}
1155
1156
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1157
	}
1158
1159
	/**
1160
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1161
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1162
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1163
	 * which is accessible via a different URI. Most of the below is copied directly
1164
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1165
	 *
1166
	 * @deprecated since 7.7.0
1167
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1168
	 */
1169 View Code Duplication
	public function alternate_xmlrpc() {
1170
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1171
1172
		if ( ! $this->connection_manager ) {
1173
			$this->connection_manager = new Connection_Manager();
1174
		}
1175
1176
		$this->connection_manager->alternate_xmlrpc();
1177
	}
1178
1179
	/**
1180
	 * The callback for the JITM ajax requests.
1181
	 *
1182
	 * @deprecated since 7.9.0
1183
	 */
1184
	function jetpack_jitm_ajax_callback() {
1185
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1186
	}
1187
1188
	/**
1189
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1190
	 */
1191
	function push_stats() {
1192
		if ( ! empty( $this->stats ) ) {
1193
			$this->do_stats( 'server_side' );
1194
		}
1195
	}
1196
1197
	/**
1198
	 * Sets the Jetpack custom capabilities.
1199
	 *
1200
	 * @param string[] $caps    Array of the user's capabilities.
1201
	 * @param string   $cap     Capability name.
1202
	 * @param int      $user_id The user ID.
1203
	 * @param array    $args    Adds the context to the cap. Typically the object ID.
1204
	 */
1205
	public function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1206
		switch ( $cap ) {
1207
			case 'jetpack_manage_modules':
1208
			case 'jetpack_activate_modules':
1209
			case 'jetpack_deactivate_modules':
1210
				$caps = array( 'manage_options' );
1211
				break;
1212
			case 'jetpack_configure_modules':
1213
				$caps = array( 'manage_options' );
1214
				break;
1215
			case 'jetpack_manage_autoupdates':
1216
				$caps = array(
1217
					'manage_options',
1218
					'update_plugins',
1219
				);
1220
				break;
1221
			case 'jetpack_network_admin_page':
1222
			case 'jetpack_network_settings_page':
1223
				$caps = array( 'manage_network_plugins' );
1224
				break;
1225
			case 'jetpack_network_sites_page':
1226
				$caps = array( 'manage_sites' );
1227
				break;
1228 View Code Duplication
			case 'jetpack_admin_page':
1229
				$is_offline_mode = ( new Status() )->is_offline_mode();
1230
				if ( $is_offline_mode ) {
1231
					$caps = array( 'manage_options' );
1232
					break;
1233
				} else {
1234
					$caps = array( 'read' );
1235
				}
1236
				break;
1237
		}
1238
		return $caps;
1239
	}
1240
1241
	/**
1242
	 * Require a Jetpack authentication.
1243
	 *
1244
	 * @deprecated since 7.7.0
1245
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1246
	 */
1247 View Code Duplication
	public function require_jetpack_authentication() {
1248
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1249
1250
		if ( ! $this->connection_manager ) {
1251
			$this->connection_manager = new Connection_Manager();
1252
		}
1253
1254
		$this->connection_manager->require_jetpack_authentication();
1255
	}
1256
1257
	/**
1258
	 * Register assets for use in various modules and the Jetpack admin page.
1259
	 *
1260
	 * @uses wp_script_is, wp_register_script, plugins_url
1261
	 * @action wp_loaded
1262
	 * @return null
1263
	 */
1264
	public function register_assets() {
1265 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1266
			wp_register_script(
1267
				'jetpack-gallery-settings',
1268
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1269
				array( 'media-views' ),
1270
				'20121225'
1271
			);
1272
		}
1273
1274
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1275
			wp_register_script(
1276
				'jetpack-twitter-timeline',
1277
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1278
				array( 'jquery' ),
1279
				'4.0.0',
1280
				true
1281
			);
1282
		}
1283
1284
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1285
			wp_register_script(
1286
				'jetpack-facebook-embed',
1287
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1288
				array(),
1289
				null,
1290
				true
1291
			);
1292
1293
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1294
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1295
			if ( ! is_numeric( $fb_app_id ) ) {
1296
				$fb_app_id = '';
1297
			}
1298
			wp_localize_script(
1299
				'jetpack-facebook-embed',
1300
				'jpfbembed',
1301
				array(
1302
					'appid'  => $fb_app_id,
1303
					'locale' => $this->get_locale(),
1304
				)
1305
			);
1306
		}
1307
1308
		/**
1309
		 * As jetpack_register_genericons is by default fired off a hook,
1310
		 * the hook may have already fired by this point.
1311
		 * So, let's just trigger it manually.
1312
		 */
1313
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1314
		jetpack_register_genericons();
1315
1316
		/**
1317
		 * Register the social logos
1318
		 */
1319
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1320
		jetpack_register_social_logos();
1321
1322 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1323
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1324
		}
1325
	}
1326
1327
	/**
1328
	 * Guess locale from language code.
1329
	 *
1330
	 * @param string $lang Language code.
1331
	 * @return string|bool
1332
	 */
1333 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1334
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1335
			return 'en_US';
1336
		}
1337
1338
		if ( ! class_exists( 'GP_Locales' ) ) {
1339
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1340
				return false;
1341
			}
1342
1343
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1344
		}
1345
1346
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1347
			// WP.com: get_locale() returns 'it'
1348
			$locale = GP_Locales::by_slug( $lang );
1349
		} else {
1350
			// Jetpack: get_locale() returns 'it_IT';
1351
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1352
		}
1353
1354
		if ( ! $locale ) {
1355
			return false;
1356
		}
1357
1358
		if ( empty( $locale->facebook_locale ) ) {
1359
			if ( empty( $locale->wp_locale ) ) {
1360
				return false;
1361
			} else {
1362
				// Facebook SDK is smart enough to fall back to en_US if a
1363
				// locale isn't supported. Since supported Facebook locales
1364
				// can fall out of sync, we'll attempt to use the known
1365
				// wp_locale value and rely on said fallback.
1366
				return $locale->wp_locale;
1367
			}
1368
		}
1369
1370
		return $locale->facebook_locale;
1371
	}
1372
1373
	/**
1374
	 * Get the locale.
1375
	 *
1376
	 * @return string|bool
1377
	 */
1378
	function get_locale() {
1379
		$locale = $this->guess_locale_from_lang( get_locale() );
1380
1381
		if ( ! $locale ) {
1382
			$locale = 'en_US';
1383
		}
1384
1385
		return $locale;
1386
	}
1387
1388
	/**
1389
	 * Return the network_site_url so that .com knows what network this site is a part of.
1390
	 *
1391
	 * @param  bool $option
1392
	 * @return string
1393
	 */
1394
	public function jetpack_main_network_site_option( $option ) {
1395
		return network_site_url();
1396
	}
1397
	/**
1398
	 * Network Name.
1399
	 */
1400
	static function network_name( $option = null ) {
1401
		global $current_site;
1402
		return $current_site->site_name;
1403
	}
1404
	/**
1405
	 * Does the network allow new user and site registrations.
1406
	 *
1407
	 * @return string
1408
	 */
1409
	static function network_allow_new_registrations( $option = null ) {
1410
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1411
	}
1412
	/**
1413
	 * Does the network allow admins to add new users.
1414
	 *
1415
	 * @return boolian
1416
	 */
1417
	static function network_add_new_users( $option = null ) {
1418
		return (bool) get_site_option( 'add_new_users' );
1419
	}
1420
	/**
1421
	 * File upload psace left per site in MB.
1422
	 *  -1 means NO LIMIT.
1423
	 *
1424
	 * @return number
1425
	 */
1426
	static function network_site_upload_space( $option = null ) {
1427
		// value in MB
1428
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1429
	}
1430
1431
	/**
1432
	 * Network allowed file types.
1433
	 *
1434
	 * @return string
1435
	 */
1436
	static function network_upload_file_types( $option = null ) {
1437
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1438
	}
1439
1440
	/**
1441
	 * Maximum file upload size set by the network.
1442
	 *
1443
	 * @return number
1444
	 */
1445
	static function network_max_upload_file_size( $option = null ) {
1446
		// value in KB
1447
		return get_site_option( 'fileupload_maxk', 300 );
1448
	}
1449
1450
	/**
1451
	 * Lets us know if a site allows admins to manage the network.
1452
	 *
1453
	 * @return array
1454
	 */
1455
	static function network_enable_administration_menus( $option = null ) {
1456
		return get_site_option( 'menu_items' );
1457
	}
1458
1459
	/**
1460
	 * If a user has been promoted to or demoted from admin, we need to clear the
1461
	 * jetpack_other_linked_admins transient.
1462
	 *
1463
	 * @since 4.3.2
1464
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1465
	 *
1466
	 * @param int    $user_id   The user ID whose role changed.
1467
	 * @param string $role      The new role.
1468
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $old_roles not be array|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
1469
	 */
1470
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1471
		if ( 'administrator' == $role
1472
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1473
			|| is_null( $old_roles )
1474
		) {
1475
			delete_transient( 'jetpack_other_linked_admins' );
1476
		}
1477
	}
1478
1479
	/**
1480
	 * Checks to see if there are any other users available to become primary
1481
	 * Users must both:
1482
	 * - Be linked to wpcom
1483
	 * - Be an admin
1484
	 *
1485
	 * @return mixed False if no other users are linked, Int if there are.
1486
	 */
1487
	static function get_other_linked_admins() {
1488
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1489
1490
		if ( false === $other_linked_users ) {
1491
			$admins = get_users( array( 'role' => 'administrator' ) );
1492
			if ( count( $admins ) > 1 ) {
1493
				$available = array();
1494
				foreach ( $admins as $admin ) {
1495
					if ( self::connection()->is_user_connected( $admin->ID ) ) {
1496
						$available[] = $admin->ID;
1497
					}
1498
				}
1499
1500
				$count_connected_admins = count( $available );
1501
				if ( count( $available ) > 1 ) {
1502
					$other_linked_users = $count_connected_admins;
1503
				} else {
1504
					$other_linked_users = 0;
1505
				}
1506
			} else {
1507
				$other_linked_users = 0;
1508
			}
1509
1510
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1511
		}
1512
1513
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1514
	}
1515
1516
	/**
1517
	 * Return whether we are dealing with a multi network setup or not.
1518
	 * The reason we are type casting this is because we want to avoid the situation where
1519
	 * the result is false since when is_main_network_option return false it cases
1520
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1521
	 * database which could be set to anything as opposed to what this function returns.
1522
	 *
1523
	 * @param  bool $option
1524
	 *
1525
	 * @return boolean
1526
	 */
1527
	public function is_main_network_option( $option ) {
1528
		// return '1' or ''
1529
		return (string) (bool) self::is_multi_network();
1530
	}
1531
1532
	/**
1533
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1534
	 *
1535
	 * @param  string $option
1536
	 * @return boolean
1537
	 */
1538
	public function is_multisite( $option ) {
1539
		return (string) (bool) is_multisite();
1540
	}
1541
1542
	/**
1543
	 * Implemented since there is no core is multi network function
1544
	 * Right now there is no way to tell if we which network is the dominant network on the system
1545
	 *
1546
	 * @since  3.3
1547
	 * @return boolean
1548
	 */
1549 View Code Duplication
	public static function is_multi_network() {
1550
		global  $wpdb;
1551
1552
		// if we don't have a multi site setup no need to do any more
1553
		if ( ! is_multisite() ) {
1554
			return false;
1555
		}
1556
1557
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1558
		if ( $num_sites > 1 ) {
1559
			return true;
1560
		} else {
1561
			return false;
1562
		}
1563
	}
1564
1565
	/**
1566
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1567
	 *
1568
	 * @return null
1569
	 */
1570
	function update_jetpack_main_network_site_option() {
1571
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1572
	}
1573
	/**
1574
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1575
	 */
1576
	function update_jetpack_network_settings() {
1577
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1578
		// Only sync this info for the main network site.
1579
	}
1580
1581
	/**
1582
	 * Get back if the current site is single user site.
1583
	 *
1584
	 * @return bool
1585
	 */
1586 View Code Duplication
	public static function is_single_user_site() {
1587
		global $wpdb;
1588
1589
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1590
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1591
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1592
		}
1593
		return 1 === (int) $some_users;
1594
	}
1595
1596
	/**
1597
	 * Returns true if the site has file write access false otherwise.
1598
	 *
1599
	 * @return string ( '1' | '0' )
1600
	 **/
1601
	public static function file_system_write_access() {
1602
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1603
			require_once ABSPATH . 'wp-admin/includes/file.php';
1604
		}
1605
1606
		require_once ABSPATH . 'wp-admin/includes/template.php';
1607
1608
		$filesystem_method = get_filesystem_method();
1609
		if ( $filesystem_method === 'direct' ) {
1610
			return 1;
1611
		}
1612
1613
		ob_start();
1614
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1615
		ob_end_clean();
1616
		if ( $filesystem_credentials_are_stored ) {
1617
			return 1;
1618
		}
1619
		return 0;
1620
	}
1621
1622
	/**
1623
	 * Finds out if a site is using a version control system.
1624
	 *
1625
	 * @return string ( '1' | '0' )
1626
	 **/
1627
	public static function is_version_controlled() {
1628
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1629
		return (string) (int) Functions::is_version_controlled();
1630
	}
1631
1632
	/**
1633
	 * Determines whether the current theme supports featured images or not.
1634
	 *
1635
	 * @return string ( '1' | '0' )
1636
	 */
1637
	public static function featured_images_enabled() {
1638
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1639
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1640
	}
1641
1642
	/**
1643
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1644
	 *
1645
	 * @deprecated 4.7 use get_avatar_url instead.
1646
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1647
	 * @param int               $size Size of the avatar image
1648
	 * @param string            $default URL to a default image to use if no avatar is available
1649
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1650
	 *
1651
	 * @return array
1652
	 */
1653
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1654
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1655
		return get_avatar_url(
1656
			$id_or_email,
1657
			array(
1658
				'size'          => $size,
1659
				'default'       => $default,
1660
				'force_default' => $force_display,
1661
			)
1662
		);
1663
	}
1664
// phpcs:disable WordPress.WP.CapitalPDangit.Misspelled
1665
	/**
1666
	 * jetpack_updates is saved in the following schema:
1667
	 *
1668
	 * array (
1669
	 *      'plugins'                       => (int) Number of plugin updates available.
1670
	 *      'themes'                        => (int) Number of theme updates available.
1671
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1672
	 *      'translations'                  => (int) Number of translation updates available.
1673
	 *      'total'                         => (int) Total of all available updates.
1674
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1675
	 * )
1676
	 *
1677
	 * @return array
1678
	 */
1679
	public static function get_updates() {
1680
		$update_data = wp_get_update_data();
1681
1682
		// Stores the individual update counts as well as the total count.
1683
		if ( isset( $update_data['counts'] ) ) {
1684
			$updates = $update_data['counts'];
1685
		}
1686
1687
		// If we need to update WordPress core, let's find the latest version number.
1688 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1689
			$cur = get_preferred_from_update_core();
1690
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1691
				$updates['wp_update_version'] = $cur->current;
1692
			}
1693
		}
1694
		return isset( $updates ) ? $updates : array();
1695
	}
1696
	// phpcs:enable
1697
1698
	public static function get_update_details() {
1699
		$update_details = array(
1700
			'update_core'    => get_site_transient( 'update_core' ),
1701
			'update_plugins' => get_site_transient( 'update_plugins' ),
1702
			'update_themes'  => get_site_transient( 'update_themes' ),
1703
		);
1704
		return $update_details;
1705
	}
1706
1707
	public static function refresh_update_data() {
1708
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1709
1710
	}
1711
1712
	public static function refresh_theme_data() {
1713
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1714
	}
1715
1716
	/**
1717
	 * Is Jetpack active?
1718
	 * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1719
	 *
1720
	 * This method is deprecated since 9.6.0. Please use one of the methods provided by the Manager class in the Connection package,
1721
	 * or Jetpack::is_connection_ready if you want to know when the Jetpack plugin starts considering the connection ready to be used.
1722
	 *
1723
	 * Since this method has a wide spread use, we decided not to throw any deprecation warnings for now.
1724
	 *
1725
	 * @deprecated 9.6.0
1726
	 *
1727
	 * @return bool
1728
	 */
1729
	public static function is_active() {
1730
		return self::connection()->is_active();
0 ignored issues
show
Deprecated Code introduced by
The method Automattic\Jetpack\Connection\Manager::is_active() has been deprecated with message: 9.6.0

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

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

Loading history...
1731
	}
1732
1733
	/**
1734
	 * Returns true if the current site is connected to WordPress.com and has the minimum requirements to enable Jetpack UI
1735
	 *
1736
	 * This method was introduced just before the release of the possibility to use Jetpack without a user connection, while
1737
	 * it was available only when no_user_testing_mode was enabled. In the near future, this will return is_connected for all
1738
	 * users and this option will be available by default for everybody.
1739
	 *
1740
	 * @since 9.6.0
1741
	 *
1742
	 * @return bool is the site connection ready to be used?
1743
	 */
1744
	public static function is_connection_ready() {
1745
		if ( ( new Status() )->is_no_user_testing_mode() ) {
1746
			return self::connection()->is_connected();
1747
		}
1748
		return (bool) self::connection()->has_connected_owner();
1749
	}
1750
1751
	/**
1752
	 * Make an API call to WordPress.com for plan status
1753
	 *
1754
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1755
	 *
1756
	 * @return bool True if plan is updated, false if no update
1757
	 */
1758
	public static function refresh_active_plan_from_wpcom() {
1759
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1760
		return Jetpack_Plan::refresh_from_wpcom();
1761
	}
1762
1763
	/**
1764
	 * Get the plan that this Jetpack site is currently using
1765
	 *
1766
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1767
	 * @return array Active Jetpack plan details.
1768
	 */
1769
	public static function get_active_plan() {
1770
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1771
		return Jetpack_Plan::get();
1772
	}
1773
1774
	/**
1775
	 * Determine whether the active plan supports a particular feature
1776
	 *
1777
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1778
	 * @return bool True if plan supports feature, false if not.
1779
	 */
1780
	public static function active_plan_supports( $feature ) {
1781
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1782
		return Jetpack_Plan::supports( $feature );
1783
	}
1784
1785
	/**
1786
	 * Deprecated: Is Jetpack in development (offline) mode?
1787
	 *
1788
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1789
	 * and themes still use it, and we do not want to flood them with notices.
1790
	 *
1791
	 * Please use Automattic\Jetpack\Status()->is_offline_mode() instead.
1792
	 *
1793
	 * @deprecated since 8.0.
1794
	 */
1795
	public static function is_development_mode() {
1796
		_deprecated_function( __METHOD__, 'jetpack-8.0', '\Automattic\Jetpack\Status->is_offline_mode' );
1797
		return ( new Status() )->is_offline_mode();
1798
	}
1799
1800
	/**
1801
	 * Whether the site is currently onboarding or not.
1802
	 * A site is considered as being onboarded if it currently has an onboarding token.
1803
	 *
1804
	 * @since 5.8
1805
	 *
1806
	 * @access public
1807
	 * @static
1808
	 *
1809
	 * @return bool True if the site is currently onboarding, false otherwise
1810
	 */
1811
	public static function is_onboarding() {
1812
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1813
	}
1814
1815
	/**
1816
	 * Determines reason for Jetpack offline mode.
1817
	 */
1818
	public static function development_mode_trigger_text() {
1819
		$status = new Status();
1820
1821
		if ( ! $status->is_offline_mode() ) {
1822
			return __( 'Jetpack is not in Offline Mode.', 'jetpack' );
1823
		}
1824
1825
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1826
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1827
		} elseif ( defined( 'WP_LOCAL_DEV' ) && WP_LOCAL_DEV ) {
1828
			$notice = __( 'The WP_LOCAL_DEV constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1829
		} elseif ( $status->is_local_site() ) {
1830
			$notice = __( 'The site URL is a known local development environment URL (e.g. http://localhost).', 'jetpack' );
1831
			/** This filter is documented in packages/status/src/class-status.php */
1832
		} elseif ( has_filter( 'jetpack_development_mode' ) && apply_filters( 'jetpack_development_mode', false ) ) { // This is a deprecated filter name.
1833
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1834
		} else {
1835
			$notice = __( 'The jetpack_offline_mode filter is set to true.', 'jetpack' );
1836
		}
1837
1838
		return $notice;
1839
1840
	}
1841
	/**
1842
	 * Get Jetpack offline mode notice text and notice class.
1843
	 *
1844
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_offline_mode
1845
	 */
1846
	public static function show_development_mode_notice() {
1847 View Code Duplication
		if ( ( new Status() )->is_offline_mode() ) {
1848
			$notice = sprintf(
1849
				/* translators: %s is a URL */
1850
				__( 'In <a href="%s" target="_blank">Offline Mode</a>:', 'jetpack' ),
1851
				Redirect::get_url( 'jetpack-support-development-mode' )
1852
			);
1853
1854
			$notice .= ' ' . self::development_mode_trigger_text();
1855
1856
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1857
		}
1858
1859
		// Throw up a notice if using a development version and as for feedback.
1860
		if ( self::is_development_version() ) {
1861
			/* translators: %s is a URL */
1862
			$notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), Redirect::get_url( 'jetpack-contact-support-beta-group' ) );
1863
1864
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1865
		}
1866
		// Throw up a notice if using staging mode
1867 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1868
			/* translators: %s is a URL */
1869
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1870
1871
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1872
		}
1873
	}
1874
1875
	/**
1876
	 * Whether Jetpack's version maps to a public release, or a development version.
1877
	 */
1878
	public static function is_development_version() {
1879
		/**
1880
		 * Allows filtering whether this is a development version of Jetpack.
1881
		 *
1882
		 * This filter is especially useful for tests.
1883
		 *
1884
		 * @since 4.3.0
1885
		 *
1886
		 * @param bool $development_version Is this a develoment version of Jetpack?
1887
		 */
1888
		return (bool) apply_filters(
1889
			'jetpack_development_version',
1890
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1891
		);
1892
	}
1893
1894
	/**
1895
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1896
	 */
1897
	public static function is_user_connected( $user_id = false ) {
1898
		_deprecated_function( __METHOD__, 'jetpack-9.5', 'Automattic\\Jetpack\\Connection\\Manager\\is_user_connected' );
1899
		return self::connection()->is_user_connected( $user_id );
0 ignored issues
show
Documentation introduced by
$user_id is of type boolean, but the function expects a false|integer.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1900
	}
1901
1902
	/**
1903
	 * Get the wpcom user data of the current|specified connected user.
1904
	 */
1905
	public static function get_connected_user_data( $user_id = null ) {
1906
		_deprecated_function( __METHOD__, 'jetpack-9.5', 'Automattic\\Jetpack\\Connection\\Manager\\get_connected_user_data' );
1907
		return self::connection()->get_connected_user_data( $user_id );
1908
	}
1909
1910
	/**
1911
	 * Get the wpcom email of the current|specified connected user.
1912
	 */
1913
	public static function get_connected_user_email( $user_id = null ) {
1914
		if ( ! $user_id ) {
1915
			$user_id = get_current_user_id();
1916
		}
1917
1918
		$xml = new Jetpack_IXR_Client(
1919
			array(
1920
				'user_id' => $user_id,
1921
			)
1922
		);
1923
		$xml->query( 'wpcom.getUserEmail' );
1924
		if ( ! $xml->isError() ) {
1925
			return $xml->getResponse();
1926
		}
1927
		return false;
1928
	}
1929
1930
	/**
1931
	 * Get the wpcom email of the master user.
1932
	 */
1933
	public static function get_master_user_email() {
1934
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1935
		if ( $master_user_id ) {
1936
			return self::get_connected_user_email( $master_user_id );
1937
		}
1938
		return '';
1939
	}
1940
1941
	/**
1942
	 * Whether the current user is the connection owner.
1943
	 *
1944
	 * @deprecated since 7.7
1945
	 *
1946
	 * @return bool Whether the current user is the connection owner.
1947
	 */
1948
	public function current_user_is_connection_owner() {
1949
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1950
		return self::connection()->is_connection_owner();
1951
	}
1952
1953
	/**
1954
	 * Gets current user IP address.
1955
	 *
1956
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1957
	 *
1958
	 * @return string                  Current user IP address.
1959
	 */
1960
	public static function current_user_ip( $check_all_headers = false ) {
1961
		if ( $check_all_headers ) {
1962
			foreach ( array(
1963
				'HTTP_CF_CONNECTING_IP',
1964
				'HTTP_CLIENT_IP',
1965
				'HTTP_X_FORWARDED_FOR',
1966
				'HTTP_X_FORWARDED',
1967
				'HTTP_X_CLUSTER_CLIENT_IP',
1968
				'HTTP_FORWARDED_FOR',
1969
				'HTTP_FORWARDED',
1970
				'HTTP_VIA',
1971
			) as $key ) {
1972
				if ( ! empty( $_SERVER[ $key ] ) ) {
1973
					return $_SERVER[ $key ];
1974
				}
1975
			}
1976
		}
1977
1978
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1979
	}
1980
1981
	/**
1982
	 * Synchronize connected user role changes
1983
	 */
1984
	function user_role_change( $user_id ) {
1985
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1986
		Users::user_role_change( $user_id );
1987
	}
1988
1989
	/**
1990
	 * Loads the currently active modules.
1991
	 */
1992
	public static function load_modules() {
1993
		$is_offline_mode = ( new Status() )->is_offline_mode();
1994
		if (
1995
			! self::is_connection_ready()
1996
			&& ! $is_offline_mode
1997
			&& ! self::is_onboarding()
1998
			&& (
1999
				! is_multisite()
2000
				|| ! get_site_option( 'jetpack_protect_active' )
2001
			)
2002
		) {
2003
			return;
2004
		}
2005
2006
		$version = Jetpack_Options::get_option( 'version' );
2007 View Code Duplication
		if ( ! $version ) {
2008
			$version = $old_version = JETPACK__VERSION . ':' . time();
2009
			/** This action is documented in class.jetpack.php */
2010
			do_action( 'updating_jetpack_version', $version, false );
2011
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2012
		}
2013
		list( $version ) = explode( ':', $version );
2014
2015
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
2016
2017
		$modules_data = array();
2018
2019
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
2020
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
2021
			$updated_modules = array();
2022
			foreach ( $modules as $module ) {
2023
				$modules_data[ $module ] = self::get_module( $module );
2024
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
2025
					continue;
2026
				}
2027
2028
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
2029
					continue;
2030
				}
2031
2032
				$updated_modules[] = $module;
2033
			}
2034
2035
			$modules = array_diff( $modules, $updated_modules );
2036
		}
2037
2038
		$is_userless = self::connection()->is_userless();
2039
2040
		foreach ( $modules as $index => $module ) {
2041
			// If we're in offline/user-less mode, disable modules requiring a connection/user connection.
2042
			if ( $is_offline_mode || $is_userless ) {
2043
				// Prime the pump if we need to
2044
				if ( empty( $modules_data[ $module ] ) ) {
2045
					$modules_data[ $module ] = self::get_module( $module );
2046
				}
2047
				// If the module requires a connection, but we're in local mode, don't include it.
2048
				if ( $is_offline_mode && $modules_data[ $module ]['requires_connection'] ) {
2049
					continue;
2050
				}
2051
2052
				if ( $is_userless && $modules_data[ $module ]['requires_user_connection'] ) {
2053
					continue;
2054
				}
2055
			}
2056
2057
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
2058
				continue;
2059
			}
2060
2061
			if ( ! include_once self::get_module_path( $module ) ) {
2062
				unset( $modules[ $index ] );
2063
				self::update_active_modules( array_values( $modules ) );
2064
				continue;
2065
			}
2066
2067
			/**
2068
			 * Fires when a specific module is loaded.
2069
			 * The dynamic part of the hook, $module, is the module slug.
2070
			 *
2071
			 * @since 1.1.0
2072
			 */
2073
			do_action( 'jetpack_module_loaded_' . $module );
2074
		}
2075
2076
		/**
2077
		 * Fires when all the modules are loaded.
2078
		 *
2079
		 * @since 1.1.0
2080
		 */
2081
		do_action( 'jetpack_modules_loaded' );
2082
2083
		// Load module-specific code that is needed even when a module isn't active. Loaded here because code contained therein may need actions such as setup_theme.
2084
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
2085
	}
2086
2087
	/**
2088
	 * Check if Jetpack's REST API compat file should be included
2089
	 *
2090
	 * @action plugins_loaded
2091
	 * @return null
2092
	 */
2093
	public function check_rest_api_compat() {
2094
		/**
2095
		 * Filters the list of REST API compat files to be included.
2096
		 *
2097
		 * @since 2.2.5
2098
		 *
2099
		 * @param array $args Array of REST API compat files to include.
2100
		 */
2101
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
2102
2103
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
2104
			require_once $_jetpack_rest_api_compat_include;
2105
		}
2106
	}
2107
2108
	/**
2109
	 * Gets all plugins currently active in values, regardless of whether they're
2110
	 * traditionally activated or network activated.
2111
	 *
2112
	 * @todo Store the result in core's object cache maybe?
2113
	 */
2114
	public static function get_active_plugins() {
2115
		$active_plugins = (array) get_option( 'active_plugins', array() );
2116
2117
		if ( is_multisite() ) {
2118
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2119
			// whereas active_plugins stores them in the values.
2120
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2121
			if ( $network_plugins ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $network_plugins of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
2122
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2123
			}
2124
		}
2125
2126
		sort( $active_plugins );
2127
2128
		return array_unique( $active_plugins );
2129
	}
2130
2131
	/**
2132
	 * Gets and parses additional plugin data to send with the heartbeat data
2133
	 *
2134
	 * @since 3.8.1
2135
	 *
2136
	 * @return array Array of plugin data
2137
	 */
2138
	public static function get_parsed_plugin_data() {
2139
		if ( ! function_exists( 'get_plugins' ) ) {
2140
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2141
		}
2142
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2143
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2144
		$active_plugins = self::get_active_plugins();
2145
2146
		$plugins = array();
2147
		foreach ( $all_plugins as $path => $plugin_data ) {
2148
			$plugins[ $path ] = array(
2149
				'is_active' => in_array( $path, $active_plugins ),
2150
				'file'      => $path,
2151
				'name'      => $plugin_data['Name'],
2152
				'version'   => $plugin_data['Version'],
2153
				'author'    => $plugin_data['Author'],
2154
			);
2155
		}
2156
2157
		return $plugins;
2158
	}
2159
2160
	/**
2161
	 * Gets and parses theme data to send with the heartbeat data
2162
	 *
2163
	 * @since 3.8.1
2164
	 *
2165
	 * @return array Array of theme data
2166
	 */
2167
	public static function get_parsed_theme_data() {
2168
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2169
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2170
2171
		$themes = array();
2172
		foreach ( $all_themes as $slug => $theme_data ) {
2173
			$theme_headers = array();
2174
			foreach ( $header_keys as $header_key ) {
2175
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2176
			}
2177
2178
			$themes[ $slug ] = array(
2179
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2180
				'slug'            => $slug,
2181
				'theme_root'      => $theme_data->get_theme_root_uri(),
2182
				'parent'          => $theme_data->parent(),
2183
				'headers'         => $theme_headers,
2184
			);
2185
		}
2186
2187
		return $themes;
2188
	}
2189
2190
	/**
2191
	 * Checks whether a specific plugin is active.
2192
	 *
2193
	 * We don't want to store these in a static variable, in case
2194
	 * there are switch_to_blog() calls involved.
2195
	 */
2196
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2197
		return in_array( $plugin, self::get_active_plugins() );
2198
	}
2199
2200
	/**
2201
	 * Check if Jetpack's Open Graph tags should be used.
2202
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2203
	 *
2204
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2205
	 * @action plugins_loaded
2206
	 * @return null
2207
	 */
2208
	public function check_open_graph() {
2209
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2210
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2211
		}
2212
2213
		$active_plugins = self::get_active_plugins();
2214
2215
		if ( ! empty( $active_plugins ) ) {
2216
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2217
				if ( in_array( $plugin, $active_plugins ) ) {
2218
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2219
					break;
2220
				}
2221
			}
2222
		}
2223
2224
		/**
2225
		 * Allow the addition of Open Graph Meta Tags to all pages.
2226
		 *
2227
		 * @since 2.0.3
2228
		 *
2229
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2230
		 */
2231
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2232
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2233
		}
2234
	}
2235
2236
	/**
2237
	 * Check if Jetpack's Twitter tags should be used.
2238
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2239
	 *
2240
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2241
	 * @action plugins_loaded
2242
	 * @return null
2243
	 */
2244
	public function check_twitter_tags() {
2245
2246
		$active_plugins = self::get_active_plugins();
2247
2248
		if ( ! empty( $active_plugins ) ) {
2249
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2250
				if ( in_array( $plugin, $active_plugins ) ) {
2251
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2252
					break;
2253
				}
2254
			}
2255
		}
2256
2257
		/**
2258
		 * Allow Twitter Card Meta tags to be disabled.
2259
		 *
2260
		 * @since 2.6.0
2261
		 *
2262
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2263
		 */
2264
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2265
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2266
		}
2267
	}
2268
2269
	/**
2270
	 * Allows plugins to submit security reports.
2271
	 *
2272
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2273
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2274
	 * @param array  $args         See definitions above
2275
	 */
2276
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2277
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2278
	}
2279
2280
	/* Jetpack Options API */
2281
2282
	public static function get_option_names( $type = 'compact' ) {
2283
		return Jetpack_Options::get_option_names( $type );
2284
	}
2285
2286
	/**
2287
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2288
	 *
2289
	 * @param string $name    Option name
2290
	 * @param mixed  $default (optional)
2291
	 */
2292
	public static function get_option( $name, $default = false ) {
2293
		return Jetpack_Options::get_option( $name, $default );
2294
	}
2295
2296
	/**
2297
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2298
	 *
2299
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2300
	 * @param string $name  Option name
2301
	 * @param mixed  $value Option value
2302
	 */
2303
	public static function update_option( $name, $value ) {
2304
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2305
		return Jetpack_Options::update_option( $name, $value );
2306
	}
2307
2308
	/**
2309
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2310
	 *
2311
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2312
	 * @param array $array array( option name => option value, ... )
2313
	 */
2314
	public static function update_options( $array ) {
2315
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2316
		return Jetpack_Options::update_options( $array );
2317
	}
2318
2319
	/**
2320
	 * Deletes the given option.  May be passed multiple option names as an array.
2321
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2322
	 *
2323
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2324
	 * @param string|array $names
2325
	 */
2326
	public static function delete_option( $names ) {
2327
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2328
		return Jetpack_Options::delete_option( $names );
2329
	}
2330
2331
	/**
2332
	 * Enters a user token into the user_tokens option
2333
	 *
2334
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Tokens->update_user_token() instead.
2335
	 *
2336
	 * @param int    $user_id The user id.
2337
	 * @param string $token The user token.
2338
	 * @param bool   $is_master_user Whether the user is the master user.
2339
	 * @return bool
2340
	 */
2341
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2342
		_deprecated_function( __METHOD__, 'jetpack-9.5', 'Automattic\\Jetpack\\Connection\\Tokens->update_user_token' );
2343
		return ( new Tokens() )->update_user_token( $user_id, $token, $is_master_user );
2344
	}
2345
2346
	/**
2347
	 * Returns an array of all PHP files in the specified absolute path.
2348
	 * Equivalent to glob( "$absolute_path/*.php" ).
2349
	 *
2350
	 * @param string $absolute_path The absolute path of the directory to search.
2351
	 * @return array Array of absolute paths to the PHP files.
2352
	 */
2353
	public static function glob_php( $absolute_path ) {
2354
		if ( function_exists( 'glob' ) ) {
2355
			return glob( "$absolute_path/*.php" );
2356
		}
2357
2358
		$absolute_path = untrailingslashit( $absolute_path );
2359
		$files         = array();
2360
		if ( ! $dir = @opendir( $absolute_path ) ) {
2361
			return $files;
2362
		}
2363
2364
		while ( false !== $file = readdir( $dir ) ) {
2365
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2366
				continue;
2367
			}
2368
2369
			$file = "$absolute_path/$file";
2370
2371
			if ( ! is_file( $file ) ) {
2372
				continue;
2373
			}
2374
2375
			$files[] = $file;
2376
		}
2377
2378
		closedir( $dir );
2379
2380
		return $files;
2381
	}
2382
2383
	public static function activate_new_modules( $redirect = false ) {
2384
		if ( ! self::is_connection_ready() && ! ( new Status() )->is_offline_mode() ) {
2385
			return;
2386
		}
2387
2388
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2389 View Code Duplication
		if ( ! $jetpack_old_version ) {
2390
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2391
			/** This action is documented in class.jetpack.php */
2392
			do_action( 'updating_jetpack_version', $version, false );
2393
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2394
		}
2395
2396
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2397
2398
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2399
			return;
2400
		}
2401
2402
		$active_modules     = self::get_active_modules();
2403
		$reactivate_modules = array();
2404
		foreach ( $active_modules as $active_module ) {
2405
			$module = self::get_module( $active_module );
2406
			if ( ! isset( $module['changed'] ) ) {
2407
				continue;
2408
			}
2409
2410
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2411
				continue;
2412
			}
2413
2414
			$reactivate_modules[] = $active_module;
2415
			self::deactivate_module( $active_module );
2416
		}
2417
2418
		$new_version = JETPACK__VERSION . ':' . time();
2419
		/** This action is documented in class.jetpack.php */
2420
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2421
		Jetpack_Options::update_options(
2422
			array(
2423
				'version'     => $new_version,
2424
				'old_version' => $jetpack_old_version,
2425
			)
2426
		);
2427
2428
		self::state( 'message', 'modules_activated' );
2429
2430
		self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2431
2432
		if ( $redirect ) {
2433
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2434
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2435
				$page = $_GET['page'];
2436
			}
2437
2438
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2439
			exit;
2440
		}
2441
	}
2442
2443
	/**
2444
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2445
	 * Make sure to tuck away module "library" files in a sub-directory.
2446
	 *
2447
	 * @param bool|string $min_version Only return modules introduced in this version or later. Default is false, do not filter.
2448
	 * @param bool|string $max_version Only return modules introduced before this version. Default is false, do not filter.
2449
	 * @param bool|null   $requires_connection Pass a boolean value to only return modules that require (or do not require) a connection.
2450
	 * @param bool|null   $requires_user_connection Pass a boolean value to only return modules that require (or do not require) a user connection.
2451
	 *
2452
	 * @return array $modules Array of module slugs
2453
	 */
2454
	public static function get_available_modules( $min_version = false, $max_version = false, $requires_connection = null, $requires_user_connection = null ) {
2455
		static $modules = null;
2456
2457
		if ( ! isset( $modules ) ) {
2458
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2459
			// Use the cache if we're on the front-end and it's available...
2460
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2461
				$modules = $available_modules_option[ JETPACK__VERSION ];
2462
			} else {
2463
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2464
2465
				$modules = array();
2466
2467
				foreach ( $files as $file ) {
2468
					if ( ! $headers = self::get_module( $file ) ) {
2469
						continue;
2470
					}
2471
2472
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2473
				}
2474
2475
				Jetpack_Options::update_option(
2476
					'available_modules',
2477
					array(
2478
						JETPACK__VERSION => $modules,
2479
					)
2480
				);
2481
			}
2482
		}
2483
2484
		/**
2485
		 * Filters the array of modules available to be activated.
2486
		 *
2487
		 * @since 2.4.0
2488
		 *
2489
		 * @param array $modules Array of available modules.
2490
		 * @param string $min_version Minimum version number required to use modules.
2491
		 * @param string $max_version Maximum version number required to use modules.
2492
		 * @param bool|null $requires_connection Value of the Requires Connection filter.
2493
		 * @param bool|null $requires_user_connection Value of the Requires User Connection filter.
2494
		 */
2495
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version, $requires_connection, $requires_user_connection );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $min_version.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
2496
2497
		if ( ! $min_version && ! $max_version && is_null( $requires_connection ) && is_null( $requires_user_connection ) ) {
2498
			return array_keys( $mods );
2499
		}
2500
2501
		$r = array();
2502
		foreach ( $mods as $slug => $introduced ) {
2503
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2504
				continue;
2505
			}
2506
2507
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2508
				continue;
2509
			}
2510
2511
			$mod_details = self::get_module( $slug );
2512
2513
			if ( null !== $requires_connection && (bool) $requires_connection !== $mod_details['requires_connection'] ) {
2514
				continue;
2515
			}
2516
2517
			if ( null !== $requires_user_connection && (bool) $requires_user_connection !== $mod_details['requires_user_connection'] ) {
2518
				continue;
2519
			}
2520
2521
			$r[] = $slug;
2522
		}
2523
2524
		return $r;
2525
	}
2526
2527
	/**
2528
	 * Get default modules loaded on activation.
2529
	 *
2530
	 * @param bool|string $min_version Onlu return modules introduced in this version or later. Default is false, do not filter.
2531
	 * @param bool|string $max_version Only return modules introduced before this version. Default is false, do not filter.
2532
	 * @param bool|null   $requires_connection Pass a boolean value to only return modules that require (or do not require) a connection.
2533
	 * @param bool|null   $requires_user_connection Pass a boolean value to only return modules that require (or do not require) a user connection.
2534
	 *
2535
	 * @return array $modules Array of module slugs
2536
	 */
2537
	public static function get_default_modules( $min_version = false, $max_version = false, $requires_connection = null, $requires_user_connection = null ) {
2538
		$return = array();
2539
2540
		foreach ( self::get_available_modules( $min_version, $max_version, $requires_connection, $requires_user_connection ) as $module ) {
2541
			$module_data = self::get_module( $module );
2542
2543
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2544
				case 'yes':
2545
					$return[] = $module;
2546
					break;
2547
				case 'public':
2548
					if ( Jetpack_Options::get_option( 'public' ) ) {
2549
						$return[] = $module;
2550
					}
2551
					break;
2552
				case 'no':
2553
				default:
2554
					break;
2555
			}
2556
		}
2557
		/**
2558
		 * Filters the array of default modules.
2559
		 *
2560
		 * @since 2.5.0
2561
		 *
2562
		 * @param array $return Array of default modules.
2563
		 * @param string $min_version Minimum version number required to use modules.
2564
		 * @param string $max_version Maximum version number required to use modules.
2565
		 * @param bool|null $requires_connection Value of the Requires Connection filter.
2566
		 * @param bool|null $requires_user_connection Value of the Requires User Connection filter.
2567
		 */
2568
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version, $requires_connection, $requires_user_connection );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $min_version.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
2569
	}
2570
2571
	/**
2572
	 * Checks activated modules during auto-activation to determine
2573
	 * if any of those modules are being deprecated.  If so, close
2574
	 * them out, and add any replacement modules.
2575
	 *
2576
	 * Runs at priority 99 by default.
2577
	 *
2578
	 * This is run late, so that it can still activate a module if
2579
	 * the new module is a replacement for another that the user
2580
	 * currently has active, even if something at the normal priority
2581
	 * would kibosh everything.
2582
	 *
2583
	 * @since 2.6
2584
	 * @uses jetpack_get_default_modules filter
2585
	 * @param array $modules
2586
	 * @return array
2587
	 */
2588
	function handle_deprecated_modules( $modules ) {
2589
		$deprecated_modules = array(
2590
			'debug'            => null,  // Closed out and moved to the debugger library.
2591
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2592
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2593
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2594
		);
2595
2596
		// Don't activate SSO if they never completed activating WPCC.
2597
		if ( self::is_module_active( 'wpcc' ) ) {
2598
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2599
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2600
				$deprecated_modules['wpcc'] = null;
2601
			}
2602
		}
2603
2604
		foreach ( $deprecated_modules as $module => $replacement ) {
2605
			if ( self::is_module_active( $module ) ) {
2606
				self::deactivate_module( $module );
2607
				if ( $replacement ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $replacement of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
2608
					$modules[] = $replacement;
2609
				}
2610
			}
2611
		}
2612
2613
		return array_unique( $modules );
2614
	}
2615
2616
	/**
2617
	 * Checks activated plugins during auto-activation to determine
2618
	 * if any of those plugins are in the list with a corresponding module
2619
	 * that is not compatible with the plugin. The module will not be allowed
2620
	 * to auto-activate.
2621
	 *
2622
	 * @since 2.6
2623
	 * @uses jetpack_get_default_modules filter
2624
	 * @param array $modules
2625
	 * @return array
2626
	 */
2627
	function filter_default_modules( $modules ) {
2628
2629
		$active_plugins = self::get_active_plugins();
2630
2631
		if ( ! empty( $active_plugins ) ) {
2632
2633
			// For each module we'd like to auto-activate...
2634
			foreach ( $modules as $key => $module ) {
2635
				// If there are potential conflicts for it...
2636
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2637
					// For each potential conflict...
2638
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2639
						// If that conflicting plugin is active...
2640
						if ( in_array( $plugin, $active_plugins ) ) {
2641
							// Remove that item from being auto-activated.
2642
							unset( $modules[ $key ] );
2643
						}
2644
					}
2645
				}
2646
			}
2647
		}
2648
2649
		return $modules;
2650
	}
2651
2652
	/**
2653
	 * Extract a module's slug from its full path.
2654
	 */
2655
	public static function get_module_slug( $file ) {
2656
		return str_replace( '.php', '', basename( $file ) );
2657
	}
2658
2659
	/**
2660
	 * Generate a module's path from its slug.
2661
	 */
2662
	public static function get_module_path( $slug ) {
2663
		/**
2664
		 * Filters the path of a modules.
2665
		 *
2666
		 * @since 7.4.0
2667
		 *
2668
		 * @param array $return The absolute path to a module's root php file
2669
		 * @param string $slug The module slug
2670
		 */
2671
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $slug.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
2672
	}
2673
2674
	/**
2675
	 * Load module data from module file. Headers differ from WordPress
2676
	 * plugin headers to avoid them being identified as standalone
2677
	 * plugins on the WordPress plugins page.
2678
	 */
2679
	public static function get_module( $module ) {
2680
		$headers = array(
2681
			'name'                      => 'Module Name',
2682
			'description'               => 'Module Description',
2683
			'sort'                      => 'Sort Order',
2684
			'recommendation_order'      => 'Recommendation Order',
2685
			'introduced'                => 'First Introduced',
2686
			'changed'                   => 'Major Changes In',
2687
			'deactivate'                => 'Deactivate',
2688
			'free'                      => 'Free',
2689
			'requires_connection'       => 'Requires Connection',
2690
			'requires_user_connection'  => 'Requires User Connection',
2691
			'auto_activate'             => 'Auto Activate',
2692
			'module_tags'               => 'Module Tags',
2693
			'feature'                   => 'Feature',
2694
			'additional_search_queries' => 'Additional Search Queries',
2695
			'plan_classes'              => 'Plans',
2696
		);
2697
2698
		static $modules_details;
2699
		$file = self::get_module_path( self::get_module_slug( $module ) );
2700
2701
		if ( isset( $modules_details[ $module ] ) ) {
2702
			$mod = $modules_details[ $module ];
2703
		} else {
2704
2705
			$mod = self::get_file_data( $file, $headers );
2706
			if ( empty( $mod['name'] ) ) {
2707
				return false;
2708
			}
2709
2710
			$mod['sort']                     = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2711
			$mod['recommendation_order']     = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2712
			$mod['deactivate']               = empty( $mod['deactivate'] );
2713
			$mod['free']                     = empty( $mod['free'] );
2714
			$mod['requires_connection']      = ( ! empty( $mod['requires_connection'] ) && 'No' === $mod['requires_connection'] ) ? false : true;
2715
			$mod['requires_user_connection'] = ( empty( $mod['requires_user_connection'] ) || 'No' === $mod['requires_user_connection'] ) ? false : true;
2716
2717
			if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ), true ) ) {
2718
				$mod['auto_activate'] = 'No';
2719
			} else {
2720
				$mod['auto_activate'] = (string) $mod['auto_activate'];
2721
			}
2722
2723
			if ( $mod['module_tags'] ) {
2724
				$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2725
				$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2726
				$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2727
			} else {
2728
				$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2729
			}
2730
2731 View Code Duplication
			if ( $mod['plan_classes'] ) {
2732
				$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2733
				$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2734
			} else {
2735
				$mod['plan_classes'] = array( 'free' );
2736
			}
2737
2738 View Code Duplication
			if ( $mod['feature'] ) {
2739
				$mod['feature'] = explode( ',', $mod['feature'] );
2740
				$mod['feature'] = array_map( 'trim', $mod['feature'] );
2741
			} else {
2742
				$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2743
			}
2744
2745
			$modules_details[ $module ] = $mod;
2746
2747
		}
2748
2749
		/**
2750
		 * Filters the feature array on a module.
2751
		 *
2752
		 * This filter allows you to control where each module is filtered: Recommended,
2753
		 * and the default "Other" listing.
2754
		 *
2755
		 * @since 3.5.0
2756
		 *
2757
		 * @param array   $mod['feature'] The areas to feature this module:
2758
		 *     'Recommended' shows on the main Jetpack admin screen.
2759
		 *     'Other' should be the default if no other value is in the array.
2760
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2761
		 * @param array   $mod All the currently assembled module data.
2762
		 */
2763
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $module.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
2764
2765
		/**
2766
		 * Filter the returned data about a module.
2767
		 *
2768
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2769
		 * so please be careful.
2770
		 *
2771
		 * @since 3.6.0
2772
		 *
2773
		 * @param array   $mod    The details of the requested module.
2774
		 * @param string  $module The slug of the module, e.g. sharedaddy
2775
		 * @param string  $file   The path to the module source file.
2776
		 */
2777
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $module.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
2778
	}
2779
2780
	/**
2781
	 * Like core's get_file_data implementation, but caches the result.
2782
	 */
2783
	public static function get_file_data( $file, $headers ) {
2784
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2785
		$file_name = basename( $file );
2786
2787
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2788
2789
		$file_data_option = get_transient( $cache_key );
2790
2791
		if ( ! is_array( $file_data_option ) ) {
2792
			delete_transient( $cache_key );
2793
			$file_data_option = false;
2794
		}
2795
2796
		if ( false === $file_data_option ) {
2797
			$file_data_option = array();
2798
		}
2799
2800
		$key           = md5( $file_name . serialize( $headers ) );
2801
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2802
2803
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2804
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2805
			return $file_data_option[ $key ];
2806
		}
2807
2808
		$data = get_file_data( $file, $headers );
2809
2810
		$file_data_option[ $key ] = $data;
2811
2812
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2813
2814
		return $data;
2815
	}
2816
2817
	/**
2818
	 * Return translated module tag.
2819
	 *
2820
	 * @param string $tag Tag as it appears in each module heading.
2821
	 *
2822
	 * @return mixed
2823
	 */
2824
	public static function translate_module_tag( $tag ) {
2825
		return jetpack_get_module_i18n_tag( $tag );
2826
	}
2827
2828
	/**
2829
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2830
	 *
2831
	 * @since 3.9.2
2832
	 *
2833
	 * @param array $modules
2834
	 *
2835
	 * @return string|void
2836
	 */
2837
	public static function get_translated_modules( $modules ) {
2838
		foreach ( $modules as $index => $module ) {
2839
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2840
			if ( isset( $module['name'] ) ) {
2841
				$modules[ $index ]['name'] = $i18n_module['name'];
2842
			}
2843
			if ( isset( $module['description'] ) ) {
2844
				$modules[ $index ]['description']       = $i18n_module['description'];
2845
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2846
			}
2847
		}
2848
		return $modules;
2849
	}
2850
2851
	/**
2852
	 * Get a list of activated modules as an array of module slugs.
2853
	 */
2854
	public static function get_active_modules() {
2855
		$active = Jetpack_Options::get_option( 'active_modules' );
2856
2857
		if ( ! is_array( $active ) ) {
2858
			$active = array();
2859
		}
2860
2861
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2862
			$active[] = 'vaultpress';
2863
		} else {
2864
			$active = array_diff( $active, array( 'vaultpress' ) );
2865
		}
2866
2867
		// If protect is active on the main site of a multisite, it should be active on all sites.
2868
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2869
			$active[] = 'protect';
2870
		}
2871
2872
		/**
2873
		 * Allow filtering of the active modules.
2874
		 *
2875
		 * Gives theme and plugin developers the power to alter the modules that
2876
		 * are activated on the fly.
2877
		 *
2878
		 * @since 5.8.0
2879
		 *
2880
		 * @param array $active Array of active module slugs.
2881
		 */
2882
		$active = apply_filters( 'jetpack_active_modules', $active );
2883
2884
		return array_unique( $active );
2885
	}
2886
2887
	/**
2888
	 * Check whether or not a Jetpack module is active.
2889
	 *
2890
	 * @param string $module The slug of a Jetpack module.
2891
	 * @return bool
2892
	 *
2893
	 * @static
2894
	 */
2895
	public static function is_module_active( $module ) {
2896
		return in_array( $module, self::get_active_modules() );
2897
	}
2898
2899
	public static function is_module( $module ) {
2900
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2901
	}
2902
2903
	/**
2904
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2905
	 *
2906
	 * @param bool $catch True to start catching, False to stop.
2907
	 *
2908
	 * @static
2909
	 */
2910
	public static function catch_errors( $catch ) {
2911
		static $display_errors, $error_reporting;
2912
2913
		if ( $catch ) {
2914
			$display_errors  = @ini_set( 'display_errors', 1 );
2915
			$error_reporting = @error_reporting( E_ALL );
2916
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2917
		} else {
2918
			@ini_set( 'display_errors', $display_errors );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2919
			@error_reporting( $error_reporting );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2920
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2921
		}
2922
	}
2923
2924
	/**
2925
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2926
	 */
2927
	public static function catch_errors_on_shutdown() {
2928
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2929
	}
2930
2931
	/**
2932
	 * Rewrite any string to make paths easier to read.
2933
	 *
2934
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2935
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2936
	 *
2937
	 * @param $string
2938
	 * @return mixed
2939
	 */
2940
	public static function alias_directories( $string ) {
2941
		// ABSPATH has a trailing slash.
2942
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2943
		// WP_CONTENT_DIR does not have a trailing slash.
2944
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2945
2946
		return $string;
2947
	}
2948
2949
	public static function activate_default_modules(
2950
		$min_version = false,
2951
		$max_version = false,
2952
		$other_modules = array(),
2953
		$redirect = null,
2954
		$send_state_messages = null,
2955
		$requires_connection = null,
2956
		$requires_user_connection = null
2957
	) {
2958
		$jetpack = self::init();
2959
2960
		if ( is_null( $redirect ) ) {
2961
			if (
2962
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2963
			||
2964
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2965
			||
2966
				( defined( 'WP_CLI' ) && WP_CLI )
2967
			||
2968
				( defined( 'DOING_CRON' ) && DOING_CRON )
2969
			||
2970
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2971
			) {
2972
				$redirect = false;
2973
			} elseif ( is_admin() ) {
2974
				$redirect = true;
2975
			} else {
2976
				$redirect = false;
2977
			}
2978
		}
2979
2980
		if ( is_null( $send_state_messages ) ) {
2981
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2982
		}
2983
2984
		$modules = self::get_default_modules( $min_version, $max_version, $requires_connection, $requires_user_connection );
2985
		$modules = array_merge( $other_modules, $modules );
2986
2987
		// Look for standalone plugins and disable if active.
2988
2989
		$to_deactivate = array();
2990
		foreach ( $modules as $module ) {
2991
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2992
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2993
			}
2994
		}
2995
2996
		$deactivated = array();
2997
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2998
			list( $probable_file, $probable_title ) = $deactivate_me;
2999
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
3000
				$deactivated[] = $module;
3001
			}
3002
		}
3003
3004
		if ( $deactivated ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $deactivated of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
3005
			if ( $send_state_messages ) {
3006
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
3007
			}
3008
3009
			if ( $redirect ) {
3010
				$url = add_query_arg(
3011
					array(
3012
						'action'   => 'activate_default_modules',
3013
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
3014
					),
3015
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
3016
				);
3017
				wp_safe_redirect( $url );
3018
				exit;
3019
			}
3020
		}
3021
3022
		/**
3023
		 * Fires before default modules are activated.
3024
		 *
3025
		 * @since 1.9.0
3026
		 *
3027
		 * @param string    $min_version Minimum version number required to use modules.
3028
		 * @param string    $max_version Maximum version number required to use modules.
3029
		 * @param array     $other_modules Array of other modules to activate alongside the default modules.
3030
		 * @param bool|null $requires_connection Value of the Requires Connection filter.
3031
		 * @param bool|null $requires_user_connection Value of the Requires User Connection filter.
3032
		 */
3033
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules, $requires_connection, $requires_user_connection );
3034
3035
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
3036
		if ( $send_state_messages ) {
3037
			self::restate();
3038
			self::catch_errors( true );
3039
		}
3040
3041
		$active = self::get_active_modules();
3042
3043
		foreach ( $modules as $module ) {
3044
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
3045
				$active[] = $module;
3046
				self::update_active_modules( $active );
3047
				continue;
3048
			}
3049
3050
			if ( $send_state_messages && in_array( $module, $active ) ) {
3051
				$module_info = self::get_module( $module );
3052 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
3053
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
3054
					if ( $active_state = self::state( $state ) ) {
3055
						$active_state = explode( ',', $active_state );
3056
					} else {
3057
						$active_state = array();
3058
					}
3059
					$active_state[] = $module;
3060
					self::state( $state, implode( ',', $active_state ) );
3061
				}
3062
				continue;
3063
			}
3064
3065
			$file = self::get_module_path( $module );
3066
			if ( ! file_exists( $file ) ) {
3067
				continue;
3068
			}
3069
3070
			// we'll override this later if the plugin can be included without fatal error
3071
			if ( $redirect ) {
3072
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3073
			}
3074
3075
			if ( $send_state_messages ) {
3076
				self::state( 'error', 'module_activation_failed' );
3077
				self::state( 'module', $module );
3078
			}
3079
3080
			ob_start();
3081
			require_once $file;
3082
3083
			$active[] = $module;
3084
3085 View Code Duplication
			if ( $send_state_messages ) {
3086
3087
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
3088
				if ( $active_state = self::state( $state ) ) {
3089
					$active_state = explode( ',', $active_state );
3090
				} else {
3091
					$active_state = array();
3092
				}
3093
				$active_state[] = $module;
3094
				self::state( $state, implode( ',', $active_state ) );
3095
			}
3096
3097
			self::update_active_modules( $active );
3098
3099
			ob_end_clean();
3100
		}
3101
3102
		if ( $send_state_messages ) {
3103
			self::state( 'error', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3104
			self::state( 'module', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3105
		}
3106
3107
		self::catch_errors( false );
3108
		/**
3109
		 * Fires when default modules are activated.
3110
		 *
3111
		 * @since 1.9.0
3112
		 *
3113
		 * @param string    $min_version Minimum version number required to use modules.
3114
		 * @param string    $max_version Maximum version number required to use modules.
3115
		 * @param array     $other_modules Array of other modules to activate alongside the default modules.
3116
		 * @param bool|null $requires_connection Value of the Requires Connection filter.
3117
		 * @param bool|null $requires_user_connection Value of the Requires User Connection filter.
3118
		 */
3119
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules, $requires_connection, $requires_user_connection );
3120
	}
3121
3122
	public static function activate_module( $module, $exit = true, $redirect = true ) {
3123
		/**
3124
		 * Fires before a module is activated.
3125
		 *
3126
		 * @since 2.6.0
3127
		 *
3128
		 * @param string $module Module slug.
3129
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
3130
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
3131
		 */
3132
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
3133
3134
		$jetpack = self::init();
3135
3136
		if ( ! strlen( $module ) ) {
3137
			return false;
3138
		}
3139
3140
		if ( ! self::is_module( $module ) ) {
3141
			return false;
3142
		}
3143
3144
		// If it's already active, then don't do it again
3145
		$active = self::get_active_modules();
3146
		foreach ( $active as $act ) {
3147
			if ( $act == $module ) {
3148
				return true;
3149
			}
3150
		}
3151
3152
		$module_data = self::get_module( $module );
3153
3154
		$is_offline_mode = ( new Status() )->is_offline_mode();
3155
		if ( ! self::is_connection_ready() ) {
3156
			if ( ! $is_offline_mode && ! self::is_onboarding() ) {
3157
				return false;
3158
			}
3159
3160
			// If we're not connected but in offline mode, make sure the module doesn't require a connection.
3161
			if ( $is_offline_mode && $module_data['requires_connection'] ) {
3162
				return false;
3163
			}
3164
		}
3165
3166
		// Check and see if the old plugin is active
3167
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3168
			// Deactivate the old plugin
3169
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3170
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3171
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3172
				self::state( 'deactivated_plugins', $module );
3173
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3174
				exit;
3175
			}
3176
		}
3177
3178
		// Protect won't work with mis-configured IPs
3179
		if ( 'protect' === $module ) {
3180
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3181
			if ( ! jetpack_protect_get_ip() ) {
3182
				self::state( 'message', 'protect_misconfigured_ip' );
3183
				return false;
3184
			}
3185
		}
3186
3187
		if ( ! Jetpack_Plan::supports( $module ) ) {
3188
			return false;
3189
		}
3190
3191
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3192
		self::state( 'module', $module );
3193
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3194
3195
		self::catch_errors( true );
3196
		ob_start();
3197
		require self::get_module_path( $module );
3198
		/** This action is documented in class.jetpack.php */
3199
		do_action( 'jetpack_activate_module', $module );
3200
		$active[] = $module;
3201
		self::update_active_modules( $active );
3202
3203
		self::state( 'error', false ); // the override
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3204
		ob_end_clean();
3205
		self::catch_errors( false );
3206
3207
		if ( $redirect ) {
3208
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3209
		}
3210
		if ( $exit ) {
3211
			exit;
3212
		}
3213
		return true;
3214
	}
3215
3216
	function activate_module_actions( $module ) {
3217
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3218
	}
3219
3220
	public static function deactivate_module( $module ) {
3221
		/**
3222
		 * Fires when a module is deactivated.
3223
		 *
3224
		 * @since 1.9.0
3225
		 *
3226
		 * @param string $module Module slug.
3227
		 */
3228
		do_action( 'jetpack_pre_deactivate_module', $module );
3229
3230
		$jetpack = self::init();
0 ignored issues
show
Unused Code introduced by
$jetpack is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3231
3232
		$active = self::get_active_modules();
3233
		$new    = array_filter( array_diff( $active, (array) $module ) );
3234
3235
		return self::update_active_modules( $new );
3236
	}
3237
3238
	public static function enable_module_configurable( $module ) {
3239
		$module = self::get_module_slug( $module );
3240
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3241
	}
3242
3243
	/**
3244
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3245
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3246
	 *
3247
	 * @param string $module Module slug
3248
	 * @return string $url module configuration URL
3249
	 */
3250
	public static function module_configuration_url( $module ) {
3251
		$module      = self::get_module_slug( $module );
3252
		$default_url = self::admin_url() . "#/settings?term=$module";
3253
		/**
3254
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3255
		 *
3256
		 * @since 6.9.0
3257
		 *
3258
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3259
		 */
3260
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3261
3262
		return $url;
3263
	}
3264
3265
	/* Installation */
3266
	public static function bail_on_activation( $message, $deactivate = true ) {
3267
		?>
3268
<!doctype html>
3269
<html>
3270
<head>
3271
<meta charset="<?php bloginfo( 'charset' ); ?>">
3272
<style>
3273
* {
3274
	text-align: center;
3275
	margin: 0;
3276
	padding: 0;
3277
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3278
}
3279
p {
3280
	margin-top: 1em;
3281
	font-size: 18px;
3282
}
3283
</style>
3284
<body>
3285
<p><?php echo esc_html( $message ); ?></p>
3286
</body>
3287
</html>
3288
		<?php
3289
		if ( $deactivate ) {
3290
			$plugins = get_option( 'active_plugins' );
3291
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3292
			$update  = false;
3293
			foreach ( $plugins as $i => $plugin ) {
3294
				if ( $plugin === $jetpack ) {
3295
					$plugins[ $i ] = false;
3296
					$update        = true;
3297
				}
3298
			}
3299
3300
			if ( $update ) {
3301
				update_option( 'active_plugins', array_filter( $plugins ) );
3302
			}
3303
		}
3304
		exit;
3305
	}
3306
3307
	/**
3308
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3309
	 *
3310
	 * @static
3311
	 */
3312
	public static function plugin_activation( $network_wide ) {
3313
		Jetpack_Options::update_option( 'activated', 1 );
3314
3315
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3316
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3317
		}
3318
3319
		if ( $network_wide ) {
3320
			self::state( 'network_nag', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3321
		}
3322
3323
		// For firing one-off events (notices) immediately after activation
3324
		set_transient( 'activated_jetpack', true, 0.1 * MINUTE_IN_SECONDS );
3325
3326
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3327
3328
		Health::on_jetpack_activated();
3329
3330
		self::plugin_initialize();
3331
	}
3332
3333
	public static function get_activation_source( $referer_url ) {
3334
3335
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3336
			return array( 'wp-cli', null );
3337
		}
3338
3339
		$referer = wp_parse_url( $referer_url );
3340
3341
		$source_type  = 'unknown';
3342
		$source_query = null;
3343
3344
		if ( ! is_array( $referer ) ) {
3345
			return array( $source_type, $source_query );
3346
		}
3347
3348
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3349
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3350
3351
		if ( isset( $referer['query'] ) ) {
3352
			parse_str( $referer['query'], $query_parts );
3353
		} else {
3354
			$query_parts = array();
3355
		}
3356
3357
		if ( $plugins_path === $referer['path'] ) {
3358
			$source_type = 'list';
3359
		} elseif ( $plugins_install_path === $referer['path'] ) {
3360
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3361
			switch ( $tab ) {
3362
				case 'popular':
3363
					$source_type = 'popular';
3364
					break;
3365
				case 'recommended':
3366
					$source_type = 'recommended';
3367
					break;
3368
				case 'favorites':
3369
					$source_type = 'favorites';
3370
					break;
3371
				case 'search':
3372
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3373
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3374
					break;
3375
				default:
3376
					$source_type = 'featured';
3377
			}
3378
		}
3379
3380
		return array( $source_type, $source_query );
3381
	}
3382
3383
	/**
3384
	 * Runs before bumping version numbers up to a new version
3385
	 *
3386
	 * @param string $version    Version:timestamp.
3387
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3388
	 */
3389
	public static function do_version_bump( $version, $old_version ) {
3390
		if ( $old_version ) { // For existing Jetpack installations.
3391
3392
			// If a front end page is visited after the update, the 'wp' action will fire.
3393
			add_action( 'wp', 'Jetpack::set_update_modal_display' );
3394
3395
			// If an admin page is visited after the update, the 'current_screen' action will fire.
3396
			add_action( 'current_screen', 'Jetpack::set_update_modal_display' );
3397
		}
3398
	}
3399
3400
	/**
3401
	 * Sets the display_update_modal state.
3402
	 */
3403
	public static function set_update_modal_display() {
3404
		self::state( 'display_update_modal', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3405
	}
3406
3407
	/**
3408
	 * Sets the internal version number and activation state.
3409
	 *
3410
	 * @static
3411
	 */
3412
	public static function plugin_initialize() {
3413
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3414
			Jetpack_Options::update_option( 'activated', 2 );
3415
		}
3416
3417 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3418
			$version = $old_version = JETPACK__VERSION . ':' . time();
3419
			/** This action is documented in class.jetpack.php */
3420
			do_action( 'updating_jetpack_version', $version, false );
3421
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3422
		}
3423
3424
		self::load_modules();
3425
3426
		Jetpack_Options::delete_option( 'do_activate' );
3427
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3428
	}
3429
3430
	/**
3431
	 * Removes all connection options
3432
	 *
3433
	 * @static
3434
	 */
3435
	public static function plugin_deactivation() {
3436
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3437
		$tracking = new Tracking();
3438
		$tracking->record_user_event( 'deactivate_plugin', array() );
3439
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3440
			Jetpack_Network::init()->deactivate();
3441
		} else {
3442
			self::disconnect( false );
3443
			// Jetpack_Heartbeat::init()->deactivate();
3444
		}
3445
	}
3446
3447
	/**
3448
	 * Disconnects from the Jetpack servers.
3449
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3450
	 *
3451
	 * @static
3452
	 */
3453
	public static function disconnect( $update_activated_state = true ) {
3454
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3455
3456
		$connection = self::connection();
3457
3458
		( new Nonce_Handler() )->clean_all();
3459
3460
		// If the site is in an IDC because sync is not allowed,
3461
		// let's make sure to not disconnect the production site.
3462
		if ( ! self::validate_sync_error_idc_option() ) {
3463
			$tracking = new Tracking();
3464
			$tracking->record_user_event( 'disconnect_site', array() );
3465
3466
			$connection->disconnect_site_wpcom( true );
3467
		}
3468
3469
		$connection->delete_all_connection_tokens( true );
3470
		Jetpack_IDC::clear_all_idc_options();
3471
3472
		if ( $update_activated_state ) {
3473
			Jetpack_Options::update_option( 'activated', 4 );
3474
		}
3475
3476
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3477
			// Check then record unique disconnection if site has never been disconnected previously
3478
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3479
				$jetpack_unique_connection['disconnected'] = 1;
3480
			} else {
3481
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3482
					// track unique disconnect
3483
					$jetpack = self::init();
3484
3485
					$jetpack->stat( 'connections', 'unique-disconnect' );
3486
					$jetpack->do_stats( 'server_side' );
3487
				}
3488
				// increment number of times disconnected
3489
				$jetpack_unique_connection['disconnected'] += 1;
3490
			}
3491
3492
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3493
		}
3494
3495
		// Delete all the sync related data. Since it could be taking up space.
3496
		Sender::get_instance()->uninstall();
3497
3498
	}
3499
3500
	/**
3501
	 * Disconnects the user
3502
	 *
3503
	 * @param int $user_id The user ID to disconnect.
3504
	 */
3505
	public function disconnect_user( $user_id ) {
3506
		$this->connection_manager->disconnect_user( $user_id );
3507
	}
3508
3509
	/**
3510
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3511
	 *
3512
	 * @deprecated since Jetpack 9.7.0
3513
	 * @see Automattic\Jetpack\Connection\Manager::try_registration()
3514
	 *
3515
	 * @return bool|WP_Error
3516
	 */
3517
	public static function try_registration() {
3518
		_deprecated_function( __METHOD__, 'jetpack-9.7', 'Automattic\\Jetpack\\Connection\\Manager::try_registration' );
3519
		return static::connection()->try_registration();
3520
	}
3521
3522
	/**
3523
	 * Checking the domain names in beta versions.
3524
	 * If this is a development version, before attempting to connect, let's make sure that the domains are viable.
3525
	 *
3526
	 * @param null|\WP_Error $error The domain validation error, or `null` if everything's fine.
3527
	 *
3528
	 * @return null|\WP_Error The domain validation error, or `null` if everything's fine.
3529
	 */
3530
	public static function registration_check_domains( $error ) {
3531
		if ( static::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3532
			$domains_to_check = array_unique(
3533
				array(
3534
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3535
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3536
				)
3537
			);
3538
			foreach ( $domains_to_check as $domain ) {
3539
				$result = static::connection()->is_usable_domain( $domain );
0 ignored issues
show
Security Bug introduced by
It seems like $domain defined by $domain on line 3538 can also be of type false; however, Automattic\Jetpack\Conne...ger::is_usable_domain() does only seem to accept string, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
3540
				if ( is_wp_error( $result ) ) {
3541
					return $result;
3542
				}
3543
			}
3544
		}
3545
3546
		return $error;
3547
	}
3548
3549
	/**
3550
	 * Tracking an internal event log. Try not to put too much chaff in here.
3551
	 *
3552
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3553
	 */
3554
	public static function log( $code, $data = null ) {
3555
		// only grab the latest 200 entries
3556
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3557
3558
		// Append our event to the log
3559
		$log_entry = array(
3560
			'time'    => time(),
3561
			'user_id' => get_current_user_id(),
3562
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3563
			'code'    => $code,
3564
		);
3565
		// Don't bother storing it unless we've got some.
3566
		if ( ! is_null( $data ) ) {
3567
			$log_entry['data'] = $data;
3568
		}
3569
		$log[] = $log_entry;
3570
3571
		// Try add_option first, to make sure it's not autoloaded.
3572
		// @todo: Add an add_option method to Jetpack_Options
3573
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3574
			Jetpack_Options::update_option( 'log', $log );
3575
		}
3576
3577
		/**
3578
		 * Fires when Jetpack logs an internal event.
3579
		 *
3580
		 * @since 3.0.0
3581
		 *
3582
		 * @param array $log_entry {
3583
		 *  Array of details about the log entry.
3584
		 *
3585
		 *  @param string time Time of the event.
3586
		 *  @param int user_id ID of the user who trigerred the event.
3587
		 *  @param int blog_id Jetpack Blog ID.
3588
		 *  @param string code Unique name for the event.
3589
		 *  @param string data Data about the event.
3590
		 * }
3591
		 */
3592
		do_action( 'jetpack_log_entry', $log_entry );
3593
	}
3594
3595
	/**
3596
	 * Get the internal event log.
3597
	 *
3598
	 * @param $event (string) - only return the specific log events
3599
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3600
	 *
3601
	 * @return array of log events || WP_Error for invalid params
3602
	 */
3603
	public static function get_log( $event = false, $num = false ) {
3604
		if ( $event && ! is_string( $event ) ) {
3605
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with __('First param must be ...g or empty', 'jetpack').

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3606
		}
3607
3608
		if ( $num && ! is_numeric( $num ) ) {
3609
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with __('Second param must be...c or empty', 'jetpack').

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3610
		}
3611
3612
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3613
3614
		// If nothing set - act as it did before, otherwise let's start customizing the output
3615
		if ( ! $num && ! $event ) {
3616
			return $entire_log;
3617
		} else {
3618
			$entire_log = array_reverse( $entire_log );
3619
		}
3620
3621
		$custom_log_output = array();
3622
3623
		if ( $event ) {
3624
			foreach ( $entire_log as $log_event ) {
3625
				if ( $event == $log_event['code'] ) {
3626
					$custom_log_output[] = $log_event;
3627
				}
3628
			}
3629
		} else {
3630
			$custom_log_output = $entire_log;
3631
		}
3632
3633
		if ( $num ) {
3634
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3635
		}
3636
3637
		return $custom_log_output;
3638
	}
3639
3640
	/**
3641
	 * Log modification of important settings.
3642
	 */
3643
	public static function log_settings_change( $option, $old_value, $value ) {
3644
		switch ( $option ) {
3645
			case 'jetpack_sync_non_public_post_stati':
3646
				self::log( $option, $value );
3647
				break;
3648
		}
3649
	}
3650
3651
	/**
3652
	 * Return stat data for WPCOM sync
3653
	 */
3654
	public static function get_stat_data( $encode = true, $extended = true ) {
3655
		$data = Jetpack_Heartbeat::generate_stats_array();
3656
3657
		if ( $extended ) {
3658
			$additional_data = self::get_additional_stat_data();
3659
			$data            = array_merge( $data, $additional_data );
3660
		}
3661
3662
		if ( $encode ) {
3663
			return json_encode( $data );
3664
		}
3665
3666
		return $data;
3667
	}
3668
3669
	/**
3670
	 * Get additional stat data to sync to WPCOM
3671
	 */
3672
	public static function get_additional_stat_data( $prefix = '' ) {
3673
		$return[ "{$prefix}themes" ]        = self::get_parsed_theme_data();
0 ignored issues
show
Coding Style Comprehensibility introduced by
$return was never initialized. Although not strictly required by PHP, it is generally a good practice to add $return = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
3674
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3675
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3676
		$return[ "{$prefix}site-count" ]    = 0;
3677
3678
		if ( function_exists( 'get_blog_count' ) ) {
3679
			$return[ "{$prefix}site-count" ] = get_blog_count();
3680
		}
3681
		return $return;
3682
	}
3683
3684
	private static function get_site_user_count() {
3685
		global $wpdb;
3686
3687
		if ( function_exists( 'wp_is_large_network' ) ) {
3688
			if ( wp_is_large_network( 'users' ) ) {
3689
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3690
			}
3691
		}
3692
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3693
			// It wasn't there, so regenerate the data and save the transient
3694
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3695
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3696
		}
3697
		return $user_count;
3698
	}
3699
3700
	/* Admin Pages */
3701
3702
	function admin_init() {
3703
		// If the plugin is not connected, display a connect message.
3704
		if (
3705
			// the plugin was auto-activated and needs its candy
3706
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3707
		||
3708
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3709
			! Jetpack_Options::get_option( 'activated' )
3710
		) {
3711
			self::plugin_initialize();
3712
		}
3713
3714
		$is_offline_mode              = ( new Status() )->is_offline_mode();
3715
		$fallback_no_verify_ssl_certs = Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' );
3716
		/** Already documented in automattic/jetpack-connection::src/class-client.php */
3717
		$client_verify_ssl_certs = apply_filters( 'jetpack_client_verify_ssl_certs', false );
3718
3719
		if ( ! $is_offline_mode ) {
3720
			Jetpack_Connection_Banner::init();
3721
		}
3722
3723
		if ( ( self::is_connection_ready() || $is_offline_mode ) && false === $fallback_no_verify_ssl_certs && ! $client_verify_ssl_certs ) {
3724
			// Upgrade: 1.1 -> 1.1.1
3725
			// Check and see if host can verify the Jetpack servers' SSL certificate
3726
			$args = array();
3727
			Client::_wp_remote_request( self::connection()->api_url( 'test' ), $args, true );
3728
		}
3729
3730
		Jetpack_Recommendations_Banner::init();
3731
3732
		if ( current_user_can( 'manage_options' ) && ! self::permit_ssl() ) {
3733
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3734
		}
3735
3736
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3737
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3738
		add_action( 'admin_enqueue_scripts', array( $this, 'deactivate_dialog' ) );
3739
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3740
3741
		if ( self::is_connection_ready() || $is_offline_mode ) {
3742
			// Artificially throw errors in certain specific cases during plugin activation.
3743
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3744
		}
3745
3746
		// Add custom column in wp-admin/users.php to show whether user is linked.
3747
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3748
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3749
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3750
	}
3751
3752
	function admin_body_class( $admin_body_class = '' ) {
3753
		$classes = explode( ' ', trim( $admin_body_class ) );
3754
3755
		$classes[] = self::is_connection_ready() ? 'jetpack-connected' : 'jetpack-disconnected';
3756
3757
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3758
		return " $admin_body_class ";
3759
	}
3760
3761
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3762
		return $admin_body_class . ' jetpack-pagestyles ';
3763
	}
3764
3765
	/**
3766
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3767
	 * This function artificially throws errors for such cases (per a specific list).
3768
	 *
3769
	 * @param string $plugin The activated plugin.
3770
	 */
3771
	function throw_error_on_activate_plugin( $plugin ) {
3772
		$active_modules = self::get_active_modules();
3773
3774
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3775
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3776
			$throw = false;
3777
3778
			// Try and make sure it really was the stats plugin
3779
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3780
				if ( 'stats.php' == basename( $plugin ) ) {
3781
					$throw = true;
3782
				}
3783
			} else {
3784
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3785
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3786
					$throw = true;
3787
				}
3788
			}
3789
3790
			if ( $throw ) {
3791
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3792
			}
3793
		}
3794
	}
3795
3796
	function intercept_plugin_error_scrape_init() {
3797
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3798
	}
3799
3800
	function intercept_plugin_error_scrape( $action, $result ) {
3801
		if ( ! $result ) {
3802
			return;
3803
		}
3804
3805
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3806
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3807
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3808
			}
3809
		}
3810
	}
3811
3812
	/**
3813
	 * Register the remote file upload request handlers, if needed.
3814
	 *
3815
	 * @access public
3816
	 */
3817
	public function add_remote_request_handlers() {
3818
		// Remote file uploads are allowed only via AJAX requests.
3819
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3820
			return;
3821
		}
3822
3823
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3824
		$remote_request_actions = array(
3825
			'jetpack_upload_file',
3826
			'jetpack_update_file',
3827
		);
3828
3829
		// phpcs:ignore WordPress.Security.NonceVerification
3830
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3831
			return;
3832
		}
3833
3834
		// Require Jetpack authentication for the remote file upload AJAX requests.
3835
		if ( ! $this->connection_manager ) {
3836
			$this->connection_manager = new Connection_Manager();
3837
		}
3838
3839
		$this->connection_manager->require_jetpack_authentication();
3840
3841
		// Register the remote file upload AJAX handlers.
3842
		foreach ( $remote_request_actions as $action ) {
3843
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3844
		}
3845
	}
3846
3847
	/**
3848
	 * Handler for Jetpack remote file uploads.
3849
	 *
3850
	 * @access public
3851
	 */
3852
	public function remote_request_handlers() {
3853
		$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...
3854
3855
		switch ( current_filter() ) {
3856
			case 'wp_ajax_nopriv_jetpack_upload_file':
3857
				$response = $this->upload_handler();
3858
				break;
3859
3860
			case 'wp_ajax_nopriv_jetpack_update_file':
3861
				$response = $this->upload_handler( true );
3862
				break;
3863
			default:
3864
				$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...
3865
				break;
3866
		}
3867
3868
		if ( ! $response ) {
3869
			$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...
3870
		}
3871
3872
		if ( is_wp_error( $response ) ) {
3873
			$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...
3874
			$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...
3875
			$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...
3876
3877
			if ( ! is_int( $status_code ) ) {
3878
				$status_code = 400;
3879
			}
3880
3881
			status_header( $status_code );
3882
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3883
		}
3884
3885
		status_header( 200 );
3886
		if ( true === $response ) {
3887
			exit;
3888
		}
3889
3890
		die( json_encode( (object) $response ) );
3891
	}
3892
3893
	/**
3894
	 * Uploads a file gotten from the global $_FILES.
3895
	 * If `$update_media_item` is true and `post_id` is defined
3896
	 * the attachment file of the media item (gotten through of the post_id)
3897
	 * will be updated instead of add a new one.
3898
	 *
3899
	 * @param  boolean $update_media_item - update media attachment
3900
	 * @return array - An array describing the uploadind files process
3901
	 */
3902
	function upload_handler( $update_media_item = false ) {
3903
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3904
			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...
3905
		}
3906
3907
		$user = wp_authenticate( '', '' );
3908
		if ( ! $user || is_wp_error( $user ) ) {
3909
			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...
3910
		}
3911
3912
		wp_set_current_user( $user->ID );
3913
3914
		if ( ! current_user_can( 'upload_files' ) ) {
3915
			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...
3916
		}
3917
3918
		if ( empty( $_FILES ) ) {
3919
			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...
3920
		}
3921
3922
		foreach ( array_keys( $_FILES ) as $files_key ) {
3923
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3924
				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...
3925
			}
3926
		}
3927
3928
		$media_keys = array_keys( $_FILES['media'] );
3929
3930
		$token = ( new Tokens() )->get_access_token( get_current_user_id() );
3931
		if ( ! $token || is_wp_error( $token ) ) {
3932
			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...
3933
		}
3934
3935
		$uploaded_files = array();
3936
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3937
		unset( $GLOBALS['post'] );
3938
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3939
			$file = array();
3940
			foreach ( $media_keys as $media_key ) {
3941
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3942
			}
3943
3944
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3945
3946
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3947
			if ( $hmac_provided !== $hmac_file ) {
3948
				$uploaded_files[ $index ] = (object) array(
3949
					'error'             => 'invalid_hmac',
3950
					'error_description' => 'The corresponding HMAC for this file does not match',
3951
				);
3952
				continue;
3953
			}
3954
3955
			$_FILES['.jetpack.upload.'] = $file;
3956
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3957
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3958
				$post_id = 0;
3959
			}
3960
3961
			if ( $update_media_item ) {
3962
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3963
					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...
3964
				}
3965
3966
				$media_array = $_FILES['media'];
3967
3968
				$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...
3969
				$file_array['type']     = $media_array['type'][0];
3970
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3971
				$file_array['error']    = $media_array['error'][0];
3972
				$file_array['size']     = $media_array['size'][0];
3973
3974
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3975
3976
				if ( is_wp_error( $edited_media_item ) ) {
3977
					return $edited_media_item;
3978
				}
3979
3980
				$response = (object) array(
3981
					'id'   => (string) $post_id,
3982
					'file' => (string) $edited_media_item->post_title,
3983
					'url'  => (string) wp_get_attachment_url( $post_id ),
3984
					'type' => (string) $edited_media_item->post_mime_type,
3985
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3986
				);
3987
3988
				return (array) array( $response );
3989
			}
3990
3991
			$attachment_id = media_handle_upload(
3992
				'.jetpack.upload.',
3993
				$post_id,
3994
				array(),
3995
				array(
3996
					'action' => 'jetpack_upload_file',
3997
				)
3998
			);
3999
4000
			if ( ! $attachment_id ) {
4001
				$uploaded_files[ $index ] = (object) array(
4002
					'error'             => 'unknown',
4003
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
4004
				);
4005
			} elseif ( is_wp_error( $attachment_id ) ) {
4006
				$uploaded_files[ $index ] = (object) array(
4007
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
4008
					'error_description' => $attachment_id->get_error_message(),
4009
				);
4010
			} else {
4011
				$attachment               = get_post( $attachment_id );
4012
				$uploaded_files[ $index ] = (object) array(
4013
					'id'   => (string) $attachment_id,
4014
					'file' => $attachment->post_title,
4015
					'url'  => wp_get_attachment_url( $attachment_id ),
4016
					'type' => $attachment->post_mime_type,
4017
					'meta' => wp_get_attachment_metadata( $attachment_id ),
4018
				);
4019
				// Zip files uploads are not supported unless they are done for installation purposed
4020
				// lets delete them in case something goes wrong in this whole process
4021
				if ( 'application/zip' === $attachment->post_mime_type ) {
4022
					// Schedule a cleanup for 2 hours from now in case of failed install.
4023
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
4024
				}
4025
			}
4026
		}
4027
		if ( ! is_null( $global_post ) ) {
4028
			$GLOBALS['post'] = $global_post;
4029
		}
4030
4031
		return $uploaded_files;
4032
	}
4033
4034
	/**
4035
	 * Add help to the Jetpack page
4036
	 *
4037
	 * @since Jetpack (1.2.3)
4038
	 * @return false if not the Jetpack page
4039
	 */
4040
	function admin_help() {
4041
		$current_screen = get_current_screen();
4042
4043
		// Overview
4044
		$current_screen->add_help_tab(
4045
			array(
4046
				'id'      => 'home',
4047
				'title'   => __( 'Home', 'jetpack' ),
4048
				'content' =>
4049
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4050
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
4051
					'<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>',
4052
			)
4053
		);
4054
4055
		// Screen Content
4056
		if ( current_user_can( 'manage_options' ) ) {
4057
			$current_screen->add_help_tab(
4058
				array(
4059
					'id'      => 'settings',
4060
					'title'   => __( 'Settings', 'jetpack' ),
4061
					'content' =>
4062
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4063
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
4064
						'<ol>' .
4065
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
4066
							'<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>' .
4067
						'</ol>' .
4068
						'<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>',
4069
				)
4070
			);
4071
		}
4072
4073
		// Help Sidebar
4074
		$support_url = Redirect::get_url( 'jetpack-support' );
4075
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
4076
		$current_screen->set_help_sidebar(
4077
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
4078
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
4079
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
4080
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
4081
		);
4082
	}
4083
4084
	function admin_menu_css() {
4085
		wp_enqueue_style( 'jetpack-icons' );
4086
	}
4087
4088
	function admin_menu_order() {
4089
		return true;
4090
	}
4091
4092
	function jetpack_menu_order( $menu_order ) {
4093
		$jp_menu_order = array();
4094
4095
		foreach ( $menu_order as $index => $item ) {
4096
			if ( $item != 'jetpack' ) {
4097
				$jp_menu_order[] = $item;
4098
			}
4099
4100
			if ( $index == 0 ) {
4101
				$jp_menu_order[] = 'jetpack';
4102
			}
4103
		}
4104
4105
		return $jp_menu_order;
4106
	}
4107
4108
	function admin_banner_styles() {
4109
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
4110
4111 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
4112
			wp_register_style(
4113
				'jetpack-dops-style',
4114
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
4115
				array(),
4116
				JETPACK__VERSION
4117
			);
4118
		}
4119
4120
		wp_enqueue_style(
4121
			'jetpack',
4122
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
4123
			array( 'jetpack-dops-style' ),
4124
			JETPACK__VERSION . '-20121016'
4125
		);
4126
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
4127
		wp_style_add_data( 'jetpack', 'suffix', $min );
4128
	}
4129
4130
	function plugin_action_links( $actions ) {
4131
4132
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
4133
4134
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_connection_ready() || ( new Status() )->is_offline_mode() ) ) {
4135
			return array_merge(
4136
				$jetpack_home,
4137
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
4138
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
4139
				$actions
4140
			);
4141
		}
4142
4143
		return array_merge( $jetpack_home, $actions );
4144
	}
4145
4146
	/**
4147
	 * Adds the deactivation warning modal if there are other active plugins using the connection
4148
	 *
4149
	 * @param string $hook The current admin page.
4150
	 *
4151
	 * @return void
4152
	 */
4153
	public function deactivate_dialog( $hook ) {
4154
		if (
4155
			'plugins.php' === $hook
4156
			&& self::is_connection_ready()
4157
		) {
4158
4159
			$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4160
4161
			if ( count( $active_plugins_using_connection ) > 1 ) {
4162
4163
				add_thickbox();
4164
4165
				wp_register_script(
4166
					'jp-tracks',
4167
					'//stats.wp.com/w.js',
4168
					array(),
4169
					gmdate( 'YW' ),
4170
					true
4171
				);
4172
4173
				wp_register_script(
4174
					'jp-tracks-functions',
4175
					plugins_url( '_inc/lib/tracks/tracks-callables.js', JETPACK__PLUGIN_FILE ),
4176
					array( 'jp-tracks' ),
4177
					JETPACK__VERSION,
4178
					false
4179
				);
4180
4181
				wp_enqueue_script(
4182
					'jetpack-deactivate-dialog-js',
4183
					Assets::get_file_url_for_environment(
4184
						'_inc/build/jetpack-deactivate-dialog.min.js',
4185
						'_inc/jetpack-deactivate-dialog.js'
4186
					),
4187
					array( 'jquery', 'jp-tracks-functions' ),
4188
					JETPACK__VERSION,
4189
					true
4190
				);
4191
4192
				wp_localize_script(
4193
					'jetpack-deactivate-dialog-js',
4194
					'deactivate_dialog',
4195
					array(
4196
						'title'            => __( 'Deactivate Jetpack', 'jetpack' ),
4197
						'deactivate_label' => __( 'Disconnect and Deactivate', 'jetpack' ),
4198
						'tracksUserData'   => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
4199
					)
4200
				);
4201
4202
				add_action( 'admin_footer', array( $this, 'deactivate_dialog_content' ) );
4203
4204
				wp_enqueue_style( 'jetpack-deactivate-dialog', plugins_url( 'css/jetpack-deactivate-dialog.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
4205
			}
4206
		}
4207
	}
4208
4209
	/**
4210
	 * Outputs the content of the deactivation modal
4211
	 *
4212
	 * @return void
4213
	 */
4214
	public function deactivate_dialog_content() {
4215
		$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4216
		unset( $active_plugins_using_connection['jetpack'] );
4217
		$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 4215 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...
4218
	}
4219
4220
	/**
4221
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4222
	 *
4223
	 * @param string $login_url The wp-login URL.
4224
	 * @param string $redirect  URL to redirect users after logging in.
4225
	 * @since Jetpack 8.4
4226
	 * @return string
4227
	 */
4228
	public function login_url( $login_url, $redirect ) {
4229
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
4230
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4231
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4232
		}
4233
		return $login_url;
4234
	}
4235
4236
	/**
4237
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4238
	 *
4239
	 * @since Jetpack 8.4
4240
	 */
4241
	public function login_init() {
4242
		// phpcs:ignore WordPress.Security.NonceVerification
4243
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4244
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4245
			wp_safe_redirect(
4246
				add_query_arg(
4247
					array(
4248
						'forceInstall' => 1,
4249
						'url'          => rawurlencode( get_site_url() ),
4250
					),
4251
					// @todo provide way to go to specific calypso env.
4252
					self::get_calypso_host() . 'jetpack/connect'
4253
				)
4254
			);
4255
			exit;
4256
		}
4257
	}
4258
4259
	/*
4260
	 * Registration flow:
4261
	 * 1 - ::admin_page_load() action=register
4262
	 * 2 - ::try_registration()
4263
	 * 3 - ::register()
4264
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4265
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4266
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4267
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4268
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4269
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4270
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4271
	 *       jetpack_id, jetpack_secret, jetpack_public
4272
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4273
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4274
	 * 5 - user logs in with WP.com account
4275
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4276
	 *		- Manager::authorize()
4277
	 *		- Manager::get_token()
4278
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4279
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4280
	 *			- which responds with access_token, token_type, scope
4281
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4282
	 *		- Jetpack::activate_default_modules()
4283
	 *     		- Deactivates deprecated plugins
4284
	 *     		- Activates all default modules
4285
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4286
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4287
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4288
	 *     Done!
4289
	 */
4290
4291
	/**
4292
	 * Handles the page load events for the Jetpack admin page
4293
	 */
4294
	function admin_page_load() {
4295
		$error = false;
4296
4297
		// Make sure we have the right body class to hook stylings for subpages off of.
4298
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4299
4300
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4301
			// Should only be used in intermediate redirects to preserve state across redirects
4302
			self::restate();
4303
		}
4304
4305
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4306
			// @todo: Add validation against a known allowed list.
4307
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4308
			// User clicked in the iframe to link their accounts
4309
			if ( ! self::connection()->is_user_connected() ) {
4310
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4311
4312
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4313
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4314
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4315
4316
				if ( isset( $_GET['notes_iframe'] ) ) {
4317
					$connect_url .= '&notes_iframe';
4318
				}
4319
				wp_redirect( $connect_url );
4320
				exit;
4321
			} else {
4322
				if ( ! isset( $_GET['calypso_env'] ) ) {
4323
					self::state( 'message', 'already_authorized' );
4324
					wp_safe_redirect( self::admin_url() );
4325
					exit;
4326
				} else {
4327
					$connect_url  = $this->build_connect_url( true, false, $from );
4328
					$connect_url .= '&already_authorized=true';
4329
					wp_redirect( $connect_url );
4330
					exit;
4331
				}
4332
			}
4333
		}
4334
4335
		if ( isset( $_GET['action'] ) ) {
4336
			switch ( $_GET['action'] ) {
4337
				case 'authorize_redirect':
4338
					self::log( 'authorize_redirect' );
4339
4340
					add_filter(
4341
						'allowed_redirect_hosts',
4342
						function ( $domains ) {
4343
							$domains[] = 'jetpack.com';
4344
							$domains[] = 'jetpack.wordpress.com';
4345
							$domains[] = 'wordpress.com';
4346
							$domains[] = wp_parse_url( static::get_calypso_host(), PHP_URL_HOST ); // May differ from `wordpress.com`.
4347
							return array_unique( $domains );
4348
						}
4349
					);
4350
4351
					// phpcs:ignore WordPress.Security.NonceVerification.Recommended
4352
					$dest_url = empty( $_GET['dest_url'] ) ? null : $_GET['dest_url'];
4353
4354
					if ( ! $dest_url || ( 0 === stripos( $dest_url, 'https://jetpack.com/' ) && 0 === stripos( $dest_url, 'https://wordpress.com/' ) ) ) {
4355
						// The destination URL is missing or invalid, nothing to do here.
4356
						exit;
4357
					}
4358
4359
					if ( static::connection()->is_connected() && static::connection()->is_user_connected() ) {
4360
						// The user is either already connected, or finished the connection process.
4361
						wp_safe_redirect( $dest_url );
4362
						exit;
4363
					} elseif ( ! empty( $_GET['done'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
4364
						// The user decided not to proceed with setting up the connection.
4365
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4366
						exit;
4367
					}
4368
4369
					$redirect_url = self::admin_url(
4370
						array(
4371
							'page'     => 'jetpack',
4372
							'action'   => 'authorize_redirect',
4373
							'dest_url' => rawurlencode( $dest_url ),
4374
							'done'     => '1',
4375
						)
4376
					);
4377
4378
					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...
4379
					exit;
4380
				case 'authorize':
4381
					_doing_it_wrong( __METHOD__, 'The `page=jetpack&action=authorize` webhook is deprecated. Use `handler=jetpack-connection-webhooks&action=authorize` instead', 'Jetpack 9.5.0' );
4382
					( new Connection_Webhooks( $this->connection_manager ) )->handle_authorize();
4383
					exit;
4384
				case 'register':
4385
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4386
						$error = 'cheatin';
4387
						break;
4388
					}
4389
					check_admin_referer( 'jetpack-register' );
4390
					self::log( 'register' );
4391
					self::maybe_set_version_option();
4392
					$registered = static::connection()->try_registration();
4393
					if ( is_wp_error( $registered ) ) {
4394
						$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...
4395
						self::state( 'error', $error );
4396
						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...
4397
4398
						/**
4399
						 * Jetpack registration Error.
4400
						 *
4401
						 * @since 7.5.0
4402
						 *
4403
						 * @param string|int $error The error code.
4404
						 * @param \WP_Error $registered The error object.
4405
						 */
4406
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4407
						break;
4408
					}
4409
4410
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4411
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4412
4413
					/**
4414
					 * Jetpack registration Success.
4415
					 *
4416
					 * @since 7.5.0
4417
					 *
4418
					 * @param string $from 'from' GET parameter;
4419
					 */
4420
					do_action( 'jetpack_connection_register_success', $from );
4421
4422
					$url = $this->build_connect_url( true, $redirect, $from );
4423
4424
					if ( ! empty( $_GET['onboarding'] ) ) {
4425
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4426
					}
4427
4428
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4429
						$url = add_query_arg( 'auth_approved', 'true', $url );
4430
					}
4431
4432
					wp_redirect( $url );
4433
					exit;
4434
				case 'activate':
4435
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4436
						$error = 'cheatin';
4437
						break;
4438
					}
4439
4440
					$module = stripslashes( $_GET['module'] );
4441
					check_admin_referer( "jetpack_activate-$module" );
4442
					self::log( 'activate', $module );
4443
					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...
4444
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4445
					}
4446
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4447
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4448
					exit;
4449
				case 'activate_default_modules':
4450
					check_admin_referer( 'activate_default_modules' );
4451
					self::log( 'activate_default_modules' );
4452
					self::restate();
4453
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4454
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4455
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4456
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4457
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4458
					exit;
4459 View Code Duplication
				case 'disconnect':
4460
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4461
						$error = 'cheatin';
4462
						break;
4463
					}
4464
4465
					check_admin_referer( 'jetpack-disconnect' );
4466
					self::log( 'disconnect' );
4467
					self::disconnect();
4468
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4469
					exit;
4470 View Code Duplication
				case 'reconnect':
4471
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4472
						$error = 'cheatin';
4473
						break;
4474
					}
4475
4476
					check_admin_referer( 'jetpack-reconnect' );
4477
					self::log( 'reconnect' );
4478
					self::disconnect();
4479
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4480
					exit;
4481 View Code Duplication
				case 'deactivate':
4482
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4483
						$error = 'cheatin';
4484
						break;
4485
					}
4486
4487
					$modules = stripslashes( $_GET['module'] );
4488
					check_admin_referer( "jetpack_deactivate-$modules" );
4489
					foreach ( explode( ',', $modules ) as $module ) {
4490
						self::log( 'deactivate', $module );
4491
						self::deactivate_module( $module );
4492
						self::state( 'message', 'module_deactivated' );
4493
					}
4494
					self::state( 'module', $modules );
4495
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4496
					exit;
4497
				case 'unlink':
4498
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4499
					check_admin_referer( 'jetpack-unlink' );
4500
					self::log( 'unlink' );
4501
					$this->connection_manager->disconnect_user();
4502
					self::state( 'message', 'unlinked' );
4503
					if ( 'sub-unlink' == $redirect ) {
4504
						wp_safe_redirect( admin_url() );
4505
					} else {
4506
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4507
					}
4508
					exit;
4509
				case 'onboard':
4510
					if ( ! current_user_can( 'manage_options' ) ) {
4511
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4512
					} else {
4513
						self::create_onboarding_token();
4514
						$url = $this->build_connect_url( true );
4515
4516
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4517
							$url = add_query_arg( 'onboarding', $token, $url );
4518
						}
4519
4520
						$calypso_env = $this->get_calypso_env();
4521
						if ( ! empty( $calypso_env ) ) {
4522
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4523
						}
4524
4525
						wp_redirect( $url );
4526
						exit;
4527
					}
4528
					exit;
4529
				default:
4530
					/**
4531
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4532
					 *
4533
					 * @since 2.6.0
4534
					 *
4535
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4536
					 */
4537
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4538
			}
4539
		}
4540
4541
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4542
			self::activate_new_modules( true );
4543
		}
4544
4545
		$message_code = self::state( 'message' );
4546
		if ( self::state( 'optin-manage' ) ) {
4547
			$activated_manage = $message_code;
4548
			$message_code     = 'jetpack-manage';
4549
		}
4550
4551
		switch ( $message_code ) {
4552
			case 'jetpack-manage':
4553
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4554
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4555
				$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>';
4556
				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...
4557
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4558
				}
4559
				break;
4560
4561
		}
4562
4563
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4564
4565
		if ( ! empty( $deactivated_plugins ) ) {
4566
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4567
			$deactivated_titles  = array();
4568
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4569
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4570
					continue;
4571
				}
4572
4573
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4574
			}
4575
4576
			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...
4577
				if ( $this->message ) {
4578
					$this->message .= "<br /><br />\n";
4579
				}
4580
4581
				$this->message .= wp_sprintf(
4582
					_n(
4583
						'Jetpack contains the most recent version of the old %l plugin.',
4584
						'Jetpack contains the most recent versions of the old %l plugins.',
4585
						count( $deactivated_titles ),
4586
						'jetpack'
4587
					),
4588
					$deactivated_titles
4589
				);
4590
4591
				$this->message .= "<br />\n";
4592
4593
				$this->message .= _n(
4594
					'The old version has been deactivated and can be removed from your site.',
4595
					'The old versions have been deactivated and can be removed from your site.',
4596
					count( $deactivated_titles ),
4597
					'jetpack'
4598
				);
4599
			}
4600
		}
4601
4602
		$this->privacy_checks = self::state( 'privacy_checks' );
4603
4604
		if ( $this->message || $this->error || $this->privacy_checks ) {
4605
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4606
		}
4607
4608
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4609
	}
4610
4611
	function admin_notices() {
4612
4613
		if ( $this->error ) {
4614
			?>
4615
<div id="message" class="jetpack-message jetpack-err">
4616
	<div class="squeezer">
4617
		<h2>
4618
			<?php
4619
			echo wp_kses(
4620
				$this->error,
4621
				array(
4622
					'a'      => array( 'href' => array() ),
4623
					'small'  => true,
4624
					'code'   => true,
4625
					'strong' => true,
4626
					'br'     => true,
4627
					'b'      => true,
4628
				)
4629
			);
4630
			?>
4631
			</h2>
4632
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4633
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4634
<?php	endif; ?>
4635
	</div>
4636
</div>
4637
			<?php
4638
		}
4639
4640
		if ( $this->message ) {
4641
			?>
4642
<div id="message" class="jetpack-message">
4643
	<div class="squeezer">
4644
		<h2>
4645
			<?php
4646
			echo wp_kses(
4647
				$this->message,
4648
				array(
4649
					'strong' => array(),
4650
					'a'      => array( 'href' => true ),
4651
					'br'     => true,
4652
				)
4653
			);
4654
			?>
4655
			</h2>
4656
	</div>
4657
</div>
4658
			<?php
4659
		}
4660
4661
		if ( $this->privacy_checks ) :
4662
			$module_names = $module_slugs = array();
4663
4664
			$privacy_checks = explode( ',', $this->privacy_checks );
4665
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4666
			foreach ( $privacy_checks as $module_slug ) {
4667
				$module = self::get_module( $module_slug );
4668
				if ( ! $module ) {
4669
					continue;
4670
				}
4671
4672
				$module_slugs[] = $module_slug;
4673
				$module_names[] = "<strong>{$module['name']}</strong>";
4674
			}
4675
4676
			$module_slugs = join( ',', $module_slugs );
4677
			?>
4678
<div id="message" class="jetpack-message jetpack-err">
4679
	<div class="squeezer">
4680
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4681
		<p>
4682
			<?php
4683
			echo wp_kses(
4684
				wptexturize(
4685
					wp_sprintf(
4686
						_nx(
4687
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4688
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4689
							count( $privacy_checks ),
4690
							'%l = list of Jetpack module/feature names',
4691
							'jetpack'
4692
						),
4693
						$module_names
4694
					)
4695
				),
4696
				array( 'strong' => true )
4697
			);
4698
4699
			echo "\n<br />\n";
4700
4701
			echo wp_kses(
4702
				sprintf(
4703
					_nx(
4704
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4705
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4706
						count( $privacy_checks ),
4707
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4708
						'jetpack'
4709
					),
4710
					wp_nonce_url(
4711
						self::admin_url(
4712
							array(
4713
								'page'   => 'jetpack',
4714
								'action' => 'deactivate',
4715
								'module' => urlencode( $module_slugs ),
4716
							)
4717
						),
4718
						"jetpack_deactivate-$module_slugs"
4719
					),
4720
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4721
				),
4722
				array(
4723
					'a' => array(
4724
						'href'  => true,
4725
						'title' => true,
4726
					),
4727
				)
4728
			);
4729
			?>
4730
		</p>
4731
	</div>
4732
</div>
4733
			<?php
4734
endif;
4735
	}
4736
4737
	/**
4738
	 * We can't always respond to a signed XML-RPC request with a
4739
	 * helpful error message. In some circumstances, doing so could
4740
	 * leak information.
4741
	 *
4742
	 * Instead, track that the error occurred via a Jetpack_Option,
4743
	 * and send that data back in the heartbeat.
4744
	 * All this does is increment a number, but it's enough to find
4745
	 * trends.
4746
	 *
4747
	 * @param WP_Error $xmlrpc_error The error produced during
4748
	 *                               signature validation.
4749
	 */
4750
	function track_xmlrpc_error( $xmlrpc_error ) {
4751
		$code = is_wp_error( $xmlrpc_error )
4752
			? $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...
4753
			: 'should-not-happen';
4754
4755
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4756
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4757
			// No need to update the option if we already have
4758
			// this code stored.
4759
			return;
4760
		}
4761
		$xmlrpc_errors[ $code ] = true;
4762
4763
		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...
4764
	}
4765
4766
	/**
4767
	 * Initialize the jetpack stats instance only when needed
4768
	 *
4769
	 * @return void
4770
	 */
4771
	private function initialize_stats() {
4772
		if ( is_null( $this->a8c_mc_stats_instance ) ) {
4773
			$this->a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4774
		}
4775
	}
4776
4777
	/**
4778
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4779
	 */
4780
	function stat( $group, $detail ) {
4781
		$this->initialize_stats();
4782
		$this->a8c_mc_stats_instance->add( $group, $detail );
4783
4784
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4785
		$this->stats = $this->a8c_mc_stats_instance->get_current_stats();
4786
	}
4787
4788
	/**
4789
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4790
	 */
4791
	function do_stats( $method = '' ) {
4792
		$this->initialize_stats();
4793
		if ( 'server_side' === $method ) {
4794
			$this->a8c_mc_stats_instance->do_server_side_stats();
4795
		} else {
4796
			$this->a8c_mc_stats_instance->do_stats();
4797
		}
4798
4799
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4800
		$this->stats = array();
4801
	}
4802
4803
	/**
4804
	 * Runs stats code for a one-off, server-side.
4805
	 *
4806
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4807
	 *
4808
	 * @return bool If it worked.
4809
	 */
4810
	static function do_server_side_stat( $args ) {
4811
		$url                   = self::build_stats_url( $args );
4812
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4813
		return $a8c_mc_stats_instance->do_server_side_stat( $url );
4814
	}
4815
4816
	/**
4817
	 * Builds the stats url.
4818
	 *
4819
	 * @param $args array|string The arguments to append to the URL.
4820
	 *
4821
	 * @return string The URL to be pinged.
4822
	 */
4823
	static function build_stats_url( $args ) {
4824
4825
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4826
		return $a8c_mc_stats_instance->build_stats_url( $args );
4827
4828
	}
4829
4830
	/**
4831
	 * Builds a URL to the Jetpack connection auth page
4832
	 *
4833
	 * @since 3.9.5
4834
	 *
4835
	 * @param bool        $raw If true, URL will not be escaped.
4836
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4837
	 *                              If string, will be a custom redirect.
4838
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4839
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4840
	 *
4841
	 * @return string Connect URL
4842
	 */
4843
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4844
		$site_id    = Jetpack_Options::get_option( 'id' );
4845
		$blog_token = ( new Tokens() )->get_access_token();
4846
4847
		if ( $register || ! $blog_token || ! $site_id ) {
4848
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4849
4850
			if ( ! empty( $redirect ) ) {
4851
				$url = add_query_arg(
4852
					'redirect',
4853
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4854
					$url
4855
				);
4856
			}
4857
4858
			if ( is_network_admin() ) {
4859
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4860
			}
4861
4862
			$calypso_env = self::get_calypso_env();
4863
4864
			if ( ! empty( $calypso_env ) ) {
4865
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4866
			}
4867
		} else {
4868
4869
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4870
			// because otherwise this logic can get us in to a loop.
4871
			$last_connect_url_check = (int) Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' );
4872
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4873
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4874
4875
				$response = Client::wpcom_json_api_request_as_blog(
4876
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4877
					'1.1'
4878
				);
4879
4880
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4881
4882
					// Generating a register URL instead to refresh the existing token
4883
					return $this->build_connect_url( $raw, $redirect, $from, true );
4884
				}
4885
			}
4886
4887
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4843 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...
4888
		}
4889
4890
		if ( $from ) {
4891
			$url = add_query_arg( 'from', $from, $url );
4892
		}
4893
4894
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4895
		/**
4896
		 * Filter the URL used when connecting a user to a WordPress.com account.
4897
		 *
4898
		 * @since 8.1.0
4899
		 *
4900
		 * @param string $url Connection URL.
4901
		 * @param bool   $raw If true, URL will not be escaped.
4902
		 */
4903
		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...
4904
	}
4905
4906
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4907
4908
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4909
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4910
4911
		if ( $iframe ) {
4912
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4913
		}
4914
4915
		$c8n = self::connection();
4916
		$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...
4917
4918
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4919
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4920
4921
		if ( $iframe ) {
4922
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4923
		}
4924
4925
		/**
4926
		 * Filter the URL used when authorizing a user to a WordPress.com account.
4927
		 *
4928
		 * @since 8.9.0
4929
		 *
4930
		 * @param string $url Connection URL.
4931
		 */
4932
		return apply_filters( 'jetpack_build_authorize_url', $url );
4933
	}
4934
4935
	/**
4936
	 * Filters the connection URL parameter array.
4937
	 *
4938
	 * @param array $args default URL parameters used by the package.
4939
	 * @return array the modified URL arguments array.
4940
	 */
4941
	public static function filter_connect_request_body( $args ) {
4942
		if (
4943
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4944
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4945
		) {
4946
			$gp_locale      = GP_Locales::by_field( 'wp_locale', get_locale() );
4947
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4948
				? $gp_locale->slug
4949
				: '';
4950
		}
4951
4952
		$tracking        = new Tracking();
4953
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4954
4955
		$args = array_merge(
4956
			$args,
4957
			array(
4958
				'_ui' => $tracks_identity['_ui'],
4959
				'_ut' => $tracks_identity['_ut'],
4960
			)
4961
		);
4962
4963
		$calypso_env = self::get_calypso_env();
4964
4965
		if ( ! empty( $calypso_env ) ) {
4966
			$args['calypso_env'] = $calypso_env;
4967
		}
4968
4969
		return $args;
4970
	}
4971
4972
	/**
4973
	 * Filters the URL that will process the connection data. It can be different from the URL
4974
	 * that we send the user to after everything is done.
4975
	 *
4976
	 * @param String $processing_url the default redirect URL used by the package.
4977
	 * @return String the modified URL.
4978
	 *
4979
	 * @deprecated since Jetpack 9.5.0
4980
	 */
4981
	public static function filter_connect_processing_url( $processing_url ) {
4982
		_deprecated_function( __METHOD__, 'jetpack-9.5' );
4983
4984
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4985
		return $processing_url;
4986
	}
4987
4988
	/**
4989
	 * Filters the redirection URL that is used for connect requests. The redirect
4990
	 * URL should return the user back to the Jetpack console.
4991
	 *
4992
	 * @param String $redirect the default redirect URL used by the package.
4993
	 * @return String the modified URL.
4994
	 */
4995
	public static function filter_connect_redirect_url( $redirect ) {
4996
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4997
		$redirect           = $redirect
4998
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4999
			: $jetpack_admin_page;
5000
5001
		if ( isset( $_REQUEST['is_multisite'] ) ) {
5002
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
5003
		}
5004
5005
		return $redirect;
5006
	}
5007
5008
	/**
5009
	 * This action fires at the beginning of the Manager::authorize method.
5010
	 */
5011
	public static function authorize_starting() {
5012
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
5013
		// Checking if site has been active/connected previously before recording unique connection.
5014
		if ( ! $jetpack_unique_connection ) {
5015
			// jetpack_unique_connection option has never been set.
5016
			$jetpack_unique_connection = array(
5017
				'connected'    => 0,
5018
				'disconnected' => 0,
5019
				'version'      => '3.6.1',
5020
			);
5021
5022
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
5023
5024
			// Track unique connection.
5025
			$jetpack = self::init();
5026
5027
			$jetpack->stat( 'connections', 'unique-connection' );
5028
			$jetpack->do_stats( 'server_side' );
5029
		}
5030
5031
		// Increment number of times connected.
5032
		$jetpack_unique_connection['connected'] += 1;
5033
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
5034
	}
5035
5036
	/**
5037
	 * This action fires when the site is registered (connected at a site level).
5038
	 */
5039
	public function handle_unique_registrations_stats() {
5040
		$jetpack_unique_registrations = Jetpack_Options::get_option( 'unique_registrations' );
5041
		// Checking if site has been registered previously before recording unique connection.
5042
		if ( ! $jetpack_unique_registrations ) {
5043
5044
			$jetpack_unique_registrations = 0;
5045
5046
			$this->stat( 'connections', 'unique-registrations' );
5047
			$this->do_stats( 'server_side' );
5048
		}
5049
5050
		// Increment number of times connected.
5051
		$jetpack_unique_registrations ++;
5052
		Jetpack_Options::update_option( 'unique_registrations', $jetpack_unique_registrations );
5053
	}
5054
5055
	/**
5056
	 * This action fires at the end of the Manager::authorize method when a secondary user is
5057
	 * linked.
5058
	 */
5059
	public static function authorize_ending_linked() {
5060
		// Don't activate anything since we are just connecting a user.
5061
		self::state( 'message', 'linked' );
5062
	}
5063
5064
	/**
5065
	 * This action fires at the end of the Manager::authorize method when the master user is
5066
	 * authorized.
5067
	 *
5068
	 * @param array $data The request data.
5069
	 */
5070
	public static function authorize_ending_authorized( $data ) {
5071
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
5072
		self::invalidate_onboarding_token();
5073
5074
		// If redirect_uri is SSO, ensure SSO module is enabled.
5075
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
5076
5077
		/** This filter is documented in class.jetpack-cli.php */
5078
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
5079
5080
		$activate_sso = (
5081
			isset( $redirect_options['action'] ) &&
5082
			'jetpack-sso' === $redirect_options['action'] &&
5083
			$jetpack_start_enable_sso
5084
		);
5085
5086
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
5087
5088
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
5089
	}
5090
5091
	/**
5092
	 * Fires on the jetpack_site_registered hook and acitvates default modules
5093
	 */
5094
	public static function activate_default_modules_on_site_register() {
5095
		$active_modules = Jetpack_Options::get_option( 'active_modules' );
5096
		if ( $active_modules ) {
5097
			self::delete_active_modules();
5098
5099
			// 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.
5100
			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...
5101
		} else {
5102
			// On a fresh new connection, at this point we activate only modules that do not require a user connection.
5103
			self::activate_default_modules( false, false, array(), false, null, null, false );
5104
		}
5105
5106
		// Since this is a fresh connection, be sure to clear out IDC options.
5107
		Jetpack_IDC::clear_all_idc_options();
5108
	}
5109
5110
	/**
5111
	 * This action fires at the end of the REST_Connector connection_reconnect method when the
5112
	 * reconnect process is completed.
5113
	 * Note that this currently only happens when we don't need the user to re-authorize
5114
	 * their WP.com account, eg in cases where we are restoring a connection with
5115
	 * unhealthy blog token.
5116
	 */
5117
	public static function reconnection_completed() {
5118
		self::state( 'message', 'reconnection_completed' );
5119
	}
5120
5121
	/**
5122
	 * Get our assumed site creation date.
5123
	 * Calculated based on the earlier date of either:
5124
	 * - Earliest admin user registration date.
5125
	 * - Earliest date of post of any post type.
5126
	 *
5127
	 * @since 7.2.0
5128
	 * @deprecated since 7.8.0
5129
	 *
5130
	 * @return string Assumed site creation date and time.
5131
	 */
5132
	public static function get_assumed_site_creation_date() {
5133
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
5134
		return self::connection()->get_assumed_site_creation_date();
5135
	}
5136
5137 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
5138
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
5139
5140
		if ( $activation_source_name ) {
5141
			$args['_as'] = urlencode( $activation_source_name );
5142
		}
5143
5144
		if ( $activation_source_keyword ) {
5145
			$args['_ak'] = urlencode( $activation_source_keyword );
5146
		}
5147
	}
5148
5149
	function build_reconnect_url( $raw = false ) {
5150
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
5151
		return $raw ? $url : esc_url( $url );
5152
	}
5153
5154
	public static function admin_url( $args = null ) {
5155
		$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...
5156
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
5157
		return $url;
5158
	}
5159
5160
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
5161
		$actionurl = str_replace( '&amp;', '&', $actionurl );
5162
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
5163
	}
5164
5165
	function dismiss_jetpack_notice() {
5166
5167
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
5168
			return;
5169
		}
5170
5171
		switch ( $_GET['jetpack-notice'] ) {
5172
			case 'dismiss':
5173
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
5174
5175
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
5176
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
5177
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
5178
				}
5179
				break;
5180
		}
5181
	}
5182
5183
	public static function sort_modules( $a, $b ) {
5184
		if ( $a['sort'] == $b['sort'] ) {
5185
			return 0;
5186
		}
5187
5188
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
5189
	}
5190
5191
	function ajax_recheck_ssl() {
5192
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5193
		$result = self::permit_ssl( true );
5194
		wp_send_json(
5195
			array(
5196
				'enabled' => $result,
5197
				'message' => get_transient( 'jetpack_https_test_message' ),
5198
			)
5199
		);
5200
	}
5201
5202
	/* Client API */
5203
5204
	/**
5205
	 * Returns the requested Jetpack API URL
5206
	 *
5207
	 * @deprecated since 7.7
5208
	 * @return string
5209
	 */
5210
	public static function api_url( $relative_url ) {
5211
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5212
		$connection = self::connection();
5213
		return $connection->api_url( $relative_url );
5214
	}
5215
5216
	/**
5217
	 * @deprecated 8.0
5218
	 *
5219
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requests.
5220
	 * But we no longer fix "bad hosts" anyway, outbound HTTPS is required for Jetpack to function.
5221
	 */
5222
	public static function fix_url_for_bad_hosts( $url ) {
5223
		_deprecated_function( __METHOD__, 'jetpack-8.0' );
5224
		return $url;
5225
	}
5226
5227
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5228
		// Default to a blog token.
5229
		$token_type = 'blog';
5230
5231
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5232
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5233
			if ( ! empty( $_GET['onboarding'] ) ) {
5234
				$jpo = $_GET;
5235
			} else {
5236
				$jpo = json_decode( $request_data, true );
5237
			}
5238
5239
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5240
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5241
5242
			if (
5243
				isset( $jpo_user )
5244
				&& isset( $jpo_token )
5245
				&& is_email( $jpo_user )
5246
				&& ctype_alnum( $jpo_token )
5247
				&& isset( $_GET['rest_route'] )
5248
				&& self::validate_onboarding_token_action(
5249
					$jpo_token,
5250
					$_GET['rest_route']
5251
				)
5252
			) {
5253
				$jp_user = get_user_by( 'email', $jpo_user );
5254
				if ( is_a( $jp_user, 'WP_User' ) ) {
5255
					wp_set_current_user( $jp_user->ID );
5256
					$user_can = is_multisite()
5257
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5258
						: current_user_can( 'manage_options' );
5259
					if ( $user_can ) {
5260
						$token_type              = 'user';
5261
						$token->external_user_id = $jp_user->ID;
5262
					}
5263
				}
5264
			}
5265
5266
			$token_data['type']    = $token_type;
5267
			$token_data['user_id'] = $token->external_user_id;
5268
		}
5269
5270
		return $token_data;
5271
	}
5272
5273
	/**
5274
	 * Create a random secret for validating onboarding payload
5275
	 *
5276
	 * @return string Secret token
5277
	 */
5278
	public static function create_onboarding_token() {
5279
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5280
			$token = wp_generate_password( 32, false );
5281
			Jetpack_Options::update_option( 'onboarding', $token );
5282
		}
5283
5284
		return $token;
5285
	}
5286
5287
	/**
5288
	 * Remove the onboarding token
5289
	 *
5290
	 * @return bool True on success, false on failure
5291
	 */
5292
	public static function invalidate_onboarding_token() {
5293
		return Jetpack_Options::delete_option( 'onboarding' );
5294
	}
5295
5296
	/**
5297
	 * Validate an onboarding token for a specific action
5298
	 *
5299
	 * @return boolean True if token/action pair is accepted, false if not
5300
	 */
5301
	public static function validate_onboarding_token_action( $token, $action ) {
5302
		// Compare tokens, bail if tokens do not match
5303
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5304
			return false;
5305
		}
5306
5307
		// List of valid actions we can take
5308
		$valid_actions = array(
5309
			'/jetpack/v4/settings',
5310
		);
5311
5312
		// Only allow valid actions.
5313
		if ( ! in_array( $action, $valid_actions ) ) {
5314
			return false;
5315
		}
5316
5317
		return true;
5318
	}
5319
5320
	/**
5321
	 * Checks to see if the URL is using SSL to connect with Jetpack
5322
	 *
5323
	 * @since 2.3.3
5324
	 * @return boolean
5325
	 */
5326
	public static function permit_ssl( $force_recheck = false ) {
5327
		// Do some fancy tests to see if ssl is being supported
5328
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5329
			$message = '';
5330
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5331
				$ssl = 0;
5332
			} else {
5333
				$ssl = 1;
5334
5335
				if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5336
					$ssl     = 0;
5337
					$message = __( 'WordPress reports no SSL support', 'jetpack' );
5338
				} else {
5339
					$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5340
					if ( is_wp_error( $response ) ) {
5341
						$ssl     = 0;
5342
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5343
					} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5344
						$ssl     = 0;
5345
						$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5346
					}
5347
				}
5348
			}
5349
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5350
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5351
		}
5352
5353
		return (bool) $ssl;
5354
	}
5355
5356
	/*
5357
	 * Displays an admin_notice, alerting the user that outbound SSL isn't working.
5358
	 */
5359
	public function alert_auto_ssl_fail() {
5360
		if ( ! current_user_can( 'manage_options' ) ) {
5361
			return;
5362
		}
5363
5364
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5365
		?>
5366
5367
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5368
			<div class="jp-banner__content">
5369
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5370
				<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>
5371
				<p>
5372
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5373
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5374
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5375
				</p>
5376
				<p>
5377
					<?php
5378
					printf(
5379
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5380
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5381
						esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5382
					);
5383
					?>
5384
				</p>
5385
			</div>
5386
		</div>
5387
		<style>
5388
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5389
		</style>
5390
		<script type="text/javascript">
5391
			jQuery( document ).ready( function( $ ) {
5392
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5393
					var $this = $( this );
5394
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5395
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5396
					e.preventDefault();
5397
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5398
					$.post( ajaxurl, data )
5399
					  .done( function( response ) {
5400
						  if ( response.enabled ) {
5401
							  $( '#jetpack-ssl-warning' ).hide();
5402
						  } else {
5403
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5404
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5405
						  }
5406
					  }.bind( $this ) );
5407
				} );
5408
			} );
5409
		</script>
5410
5411
		<?php
5412
	}
5413
5414
	/**
5415
	 * Returns the Jetpack XML-RPC API
5416
	 *
5417
	 * @deprecated 8.0 Use Connection_Manager instead.
5418
	 * @return string
5419
	 */
5420
	public static function xmlrpc_api_url() {
5421
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5422
		return self::connection()->xmlrpc_api_url();
5423
	}
5424
5425
	/**
5426
	 * Returns the connection manager object.
5427
	 *
5428
	 * @return Automattic\Jetpack\Connection\Manager
5429
	 */
5430
	public static function connection() {
5431
		$jetpack = static::init();
5432
5433
		// If the connection manager hasn't been instantiated, do that now.
5434
		if ( ! $jetpack->connection_manager ) {
5435
			$jetpack->connection_manager = new Connection_Manager( 'jetpack' );
5436
		}
5437
5438
		return $jetpack->connection_manager;
5439
	}
5440
5441
	/**
5442
	 * Creates two secret tokens and the end of life timestamp for them.
5443
	 *
5444
	 * Note these tokens are unique per call, NOT static per site for connecting.
5445
	 *
5446
	 * @deprecated 9.5 Use Automattic\Jetpack\Connection\Secrets->generate() instead.
5447
	 *
5448
	 * @since 2.6
5449
	 * @param String  $action  The action name.
5450
	 * @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...
5451
	 * @param Integer $exp     Expiration time in seconds.
5452
	 * @return array
5453
	 */
5454
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5455
		_deprecated_function( __METHOD__, 'jetpack-9.5', 'Automattic\\Jetpack\\Connection\\Secrets->generate' );
5456
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5457
	}
5458
5459
	public static function get_secrets( $action, $user_id ) {
5460
		$secrets = ( new Secrets() )->get( $action, $user_id );
5461
5462
		if ( Secrets::SECRETS_MISSING === $secrets ) {
5463
			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...
5464
		}
5465
5466
		if ( Secrets::SECRETS_EXPIRED === $secrets ) {
5467
			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...
5468
		}
5469
5470
		return $secrets;
5471
	}
5472
5473
	/**
5474
	 * Builds the timeout limit for queries talking with the wpcom servers.
5475
	 *
5476
	 * Based on local php max_execution_time in php.ini
5477
	 *
5478
	 * @since 2.6
5479
	 * @return int
5480
	 * @deprecated
5481
	 **/
5482
	public function get_remote_query_timeout_limit() {
5483
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5484
		return self::get_max_execution_time();
5485
	}
5486
5487
	/**
5488
	 * Builds the timeout limit for queries talking with the wpcom servers.
5489
	 *
5490
	 * Based on local php max_execution_time in php.ini
5491
	 *
5492
	 * @since 5.4
5493
	 * @return int
5494
	 **/
5495
	public static function get_max_execution_time() {
5496
		$timeout = (int) ini_get( 'max_execution_time' );
5497
5498
		// Ensure exec time set in php.ini
5499
		if ( ! $timeout ) {
5500
			$timeout = 30;
5501
		}
5502
		return $timeout;
5503
	}
5504
5505
	/**
5506
	 * Sets a minimum request timeout, and returns the current timeout
5507
	 *
5508
	 * @since 5.4
5509
	 **/
5510 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5511
		$timeout = self::get_max_execution_time();
5512
		if ( $timeout < $min_timeout ) {
5513
			$timeout = $min_timeout;
5514
			set_time_limit( $timeout );
5515
		}
5516
		return $timeout;
5517
	}
5518
5519
	/**
5520
	 * Takes the response from the Jetpack register new site endpoint and
5521
	 * verifies it worked properly.
5522
	 *
5523
	 * @since 2.6
5524
	 * @deprecated since 7.7.0
5525
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5526
	 **/
5527
	public function validate_remote_register_response() {
5528
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5529
	}
5530
5531
	/**
5532
	 * @deprecated since Jetpack 9.7.0
5533
	 * @see Automattic\Jetpack\Connection\Manager::try_registration()
5534
	 *
5535
	 * @return bool|WP_Error
5536
	 */
5537
	public static function register() {
5538
		_deprecated_function( __METHOD__, 'jetpack-9.7', 'Automattic\\Jetpack\\Connection\\Manager::try_registration' );
5539
		return static::connection()->try_registration( false );
5540
	}
5541
5542
	/**
5543
	 * Filters the registration request body to include tracking properties.
5544
	 *
5545
	 * @deprecated since Jetpack 9.7.0
5546
	 * @see Automattic\Jetpack\Connection\Utils::filter_register_request_body()
5547
	 *
5548
	 * @param array $properties
5549
	 * @return array amended properties.
5550
	 */
5551
	public static function filter_register_request_body( $properties ) {
5552
		_deprecated_function( __METHOD__, 'jetpack-9.7', 'Automattic\\Jetpack\\Connection\\Utils::filter_register_request_body' );
5553
		return Connection_Utils::filter_register_request_body( $properties );
5554
	}
5555
5556
	/**
5557
	 * Filters the token request body to include tracking properties.
5558
	 *
5559
	 * @param array $properties
5560
	 * @return array amended properties.
5561
	 */
5562 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5563
		$tracking        = new Tracking();
5564
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5565
5566
		return array_merge(
5567
			$properties,
5568
			array(
5569
				'_ui' => $tracks_identity['_ui'],
5570
				'_ut' => $tracks_identity['_ut'],
5571
			)
5572
		);
5573
	}
5574
5575
	/**
5576
	 * If the db version is showing something other that what we've got now, bump it to current.
5577
	 *
5578
	 * @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...
5579
	 */
5580
	public static function maybe_set_version_option() {
5581
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5582
		if ( JETPACK__VERSION != $version ) {
5583
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5584
5585
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5586
				/** This action is documented in class.jetpack.php */
5587
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5588
			}
5589
5590
			return true;
5591
		}
5592
		return false;
5593
	}
5594
5595
	/* Client Server API */
5596
5597
	/**
5598
	 * Loads the Jetpack XML-RPC client.
5599
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5600
	 *
5601
	 * @deprecated since 7.7.0
5602
	 */
5603
	public static function load_xml_rpc_client() {
5604
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5605
	}
5606
5607
	/**
5608
	 * Resets the saved authentication state in between testing requests.
5609
	 *
5610
	 * @deprecated since 8.9.0
5611
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::reset_saved_auth_state()
5612
	 */
5613
	public function reset_saved_auth_state() {
5614
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::reset_saved_auth_state' );
5615
		Connection_Rest_Authentication::init()->reset_saved_auth_state();
5616
	}
5617
5618
	/**
5619
	 * Verifies the signature of the current request.
5620
	 *
5621
	 * @deprecated since 7.7.0
5622
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5623
	 *
5624
	 * @return false|array
5625
	 */
5626
	public function verify_xml_rpc_signature() {
5627
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5628
		return self::connection()->verify_xml_rpc_signature();
5629
	}
5630
5631
	/**
5632
	 * Verifies the signature of the current request.
5633
	 *
5634
	 * This function has side effects and should not be used. Instead,
5635
	 * use the memoized version `->verify_xml_rpc_signature()`.
5636
	 *
5637
	 * @deprecated since 7.7.0
5638
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5639
	 * @internal
5640
	 */
5641
	private function internal_verify_xml_rpc_signature() {
5642
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5643
	}
5644
5645
	/**
5646
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5647
	 *
5648
	 * @deprecated since 7.7.0
5649
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5650
	 *
5651
	 * @param \WP_User|mixed $user     User object if authenticated.
5652
	 * @param string         $username Username.
5653
	 * @param string         $password Password string.
5654
	 * @return \WP_User|mixed Authenticated user or error.
5655
	 */
5656 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5657
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5658
5659
		if ( ! $this->connection_manager ) {
5660
			$this->connection_manager = new Connection_Manager();
5661
		}
5662
5663
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5664
	}
5665
5666
	/**
5667
	 * Authenticates requests from Jetpack server to WP REST API endpoints.
5668
	 * Uses the existing XMLRPC request signing implementation.
5669
	 *
5670
	 * @deprecated since 8.9.0
5671
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authenticate()
5672
	 */
5673
	function wp_rest_authenticate( $user ) {
5674
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::wp_rest_authenticate' );
5675
		return Connection_Rest_Authentication::init()->wp_rest_authenticate( $user );
5676
	}
5677
5678
	/**
5679
	 * Report authentication status to the WP REST API.
5680
	 *
5681
	 * @deprecated since 8.9.0
5682
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
5683
	 *
5684
	 * @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...
5685
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5686
	 */
5687
	public function wp_rest_authentication_errors( $value ) {
5688
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::wp_rest_authenication_errors' );
5689
		return Connection_Rest_Authentication::init()->wp_rest_authentication_errors( $value );
5690
	}
5691
5692
	/**
5693
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5694
	 * Capture it here so we can verify the signature later.
5695
	 *
5696
	 * @deprecated since 7.7.0
5697
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5698
	 *
5699
	 * @param array $methods XMLRPC methods.
5700
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5701
	 */
5702 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5703
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5704
5705
		if ( ! $this->connection_manager ) {
5706
			$this->connection_manager = new Connection_Manager();
5707
		}
5708
5709
		return $this->connection_manager->xmlrpc_methods( $methods );
5710
	}
5711
5712
	/**
5713
	 * Register additional public XMLRPC methods.
5714
	 *
5715
	 * @deprecated since 7.7.0
5716
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5717
	 *
5718
	 * @param array $methods Public XMLRPC methods.
5719
	 * @return array Public XMLRPC methods, with the getOptions one.
5720
	 */
5721 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5722
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5723
5724
		if ( ! $this->connection_manager ) {
5725
			$this->connection_manager = new Connection_Manager();
5726
		}
5727
5728
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5729
	}
5730
5731
	/**
5732
	 * Handles a getOptions XMLRPC method call.
5733
	 *
5734
	 * @deprecated since 7.7.0
5735
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5736
	 *
5737
	 * @param array $args method call arguments.
5738
	 * @return array an amended XMLRPC server options array.
5739
	 */
5740 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5741
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5742
5743
		if ( ! $this->connection_manager ) {
5744
			$this->connection_manager = new Connection_Manager();
5745
		}
5746
5747
		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...
5748
	}
5749
5750
	/**
5751
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5752
	 *
5753
	 * @deprecated since 7.7.0
5754
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5755
	 *
5756
	 * @param array $options Standard Core options.
5757
	 * @return array Amended options.
5758
	 */
5759 View Code Duplication
	public function xmlrpc_options( $options ) {
5760
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5761
5762
		if ( ! $this->connection_manager ) {
5763
			$this->connection_manager = new Connection_Manager();
5764
		}
5765
5766
		return $this->connection_manager->xmlrpc_options( $options );
5767
	}
5768
5769
	/**
5770
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5771
	 * SET: state( $key, $value );
5772
	 * GET: $value = state( $key );
5773
	 *
5774
	 * @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...
5775
	 * @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...
5776
	 * @param bool   $restate private
5777
	 */
5778
	public static function state( $key = null, $value = null, $restate = false ) {
5779
		static $state = array();
5780
		static $path, $domain;
5781
		if ( ! isset( $path ) ) {
5782
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5783
			$admin_url = self::admin_url();
5784
			$bits      = wp_parse_url( $admin_url );
5785
5786
			if ( is_array( $bits ) ) {
5787
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5788
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5789
			} else {
5790
				$path = $domain = null;
5791
			}
5792
		}
5793
5794
		// Extract state from cookies and delete cookies
5795
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5796
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5797
			unset( $_COOKIE['jetpackState'] );
5798
			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...
5799
				if ( strlen( $v ) ) {
5800
					$state[ $k ] = $v;
5801
				}
5802
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5803
			}
5804
		}
5805
5806
		if ( $restate ) {
5807
			foreach ( $state as $k => $v ) {
5808
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5809
			}
5810
			return;
5811
		}
5812
5813
		// Get a state variable.
5814
		if ( isset( $key ) && ! isset( $value ) ) {
5815
			if ( array_key_exists( $key, $state ) ) {
5816
				return $state[ $key ];
5817
			}
5818
			return null;
5819
		}
5820
5821
		// Set a state variable.
5822
		if ( isset( $key ) && isset( $value ) ) {
5823
			if ( is_array( $value ) && isset( $value[0] ) ) {
5824
				$value = $value[0];
5825
			}
5826
			$state[ $key ] = $value;
5827
			if ( ! headers_sent() ) {
5828
				if ( self::should_set_cookie( $key ) ) {
5829
					setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5830
				}
5831
			}
5832
		}
5833
	}
5834
5835
	public static function restate() {
5836
		self::state( null, null, true );
5837
	}
5838
5839
	/**
5840
	 * Determines whether the jetpackState[$key] value should be added to the
5841
	 * cookie.
5842
	 *
5843
	 * @param string $key The state key.
5844
	 *
5845
	 * @return boolean Whether the value should be added to the cookie.
5846
	 */
5847
	public static function should_set_cookie( $key ) {
5848
		global $current_screen;
5849
		$page = isset( $current_screen->base ) ? $current_screen->base : null;
5850
5851
		if ( 'toplevel_page_jetpack' === $page && 'display_update_modal' === $key ) {
5852
			return false;
5853
		}
5854
5855
		return true;
5856
	}
5857
5858
	public static function check_privacy( $file ) {
5859
		static $is_site_publicly_accessible = null;
5860
5861
		if ( is_null( $is_site_publicly_accessible ) ) {
5862
			$is_site_publicly_accessible = false;
5863
5864
			$rpc = new Jetpack_IXR_Client();
5865
5866
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5867
			if ( $success ) {
5868
				$response = $rpc->getResponse();
5869
				if ( $response ) {
5870
					$is_site_publicly_accessible = true;
5871
				}
5872
			}
5873
5874
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5875
		}
5876
5877
		if ( $is_site_publicly_accessible ) {
5878
			return;
5879
		}
5880
5881
		$module_slug = self::get_module_slug( $file );
5882
5883
		$privacy_checks = self::state( 'privacy_checks' );
5884
		if ( ! $privacy_checks ) {
5885
			$privacy_checks = $module_slug;
5886
		} else {
5887
			$privacy_checks .= ",$module_slug";
5888
		}
5889
5890
		self::state( 'privacy_checks', $privacy_checks );
5891
	}
5892
5893
	/**
5894
	 * Helper method for multicall XMLRPC.
5895
	 *
5896
	 * @deprecated since 8.9.0
5897
	 * @see Automattic\\Jetpack\\Connection\\Xmlrpc_Async_Call::add_call()
5898
	 *
5899
	 * @param ...$args Args for the async_call.
5900
	 */
5901
	public static function xmlrpc_async_call( ...$args ) {
5902
5903
		_deprecated_function( 'Jetpack::xmlrpc_async_call', 'jetpack-8.9.0', 'Automattic\\Jetpack\\Connection\\Xmlrpc_Async_Call::add_call' );
5904
5905
		global $blog_id;
5906
		static $clients = array();
5907
5908
		$client_blog_id = is_multisite() ? $blog_id : 0;
5909
5910
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5911
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => true ) );
5912
			if ( function_exists( 'ignore_user_abort' ) ) {
5913
				ignore_user_abort( true );
5914
			}
5915
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5916
		}
5917
5918
		if ( ! empty( $args[0] ) ) {
5919
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5920
		} elseif ( is_multisite() ) {
5921
			foreach ( $clients as $client_blog_id => $client ) {
5922
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5923
					continue;
5924
				}
5925
5926
				$switch_success = switch_to_blog( $client_blog_id, true );
5927
				if ( ! $switch_success ) {
5928
					continue;
5929
				}
5930
5931
				flush();
5932
				$client->query();
5933
5934
				restore_current_blog();
5935
			}
5936
		} else {
5937
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5938
				flush();
5939
				$clients[0]->query();
5940
			}
5941
		}
5942
	}
5943
5944
	/**
5945
	 * Serve a WordPress.com static resource via a randomized wp.com subdomain.
5946
	 *
5947
	 * @deprecated 9.3.0 Use Assets::staticize_subdomain.
5948
	 *
5949
	 * @param string $url WordPress.com static resource URL.
5950
	 */
5951
	public static function staticize_subdomain( $url ) {
5952
		_deprecated_function( __METHOD__, 'jetpack-9.3.0', 'Automattic\Jetpack\Assets::staticize_subdomain' );
5953
		return Assets::staticize_subdomain( $url );
5954
	}
5955
5956
	/* JSON API Authorization */
5957
5958
	/**
5959
	 * Handles the login action for Authorizing the JSON API
5960
	 */
5961
	function login_form_json_api_authorization() {
5962
		$this->verify_json_api_authorization_request();
5963
5964
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5965
5966
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5967
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5968
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5969
	}
5970
5971
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5972
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5973
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5974
			return $url;
5975
		}
5976
5977
		$parsed_url = wp_parse_url( $url );
5978
		$url        = strtok( $url, '?' );
5979
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5980
		if ( ! empty( $parsed_url['query'] ) ) {
5981
			$url .= "&{$parsed_url['query']}";
5982
		}
5983
5984
		return $url;
5985
	}
5986
5987
	// Make sure the POSTed request is handled by the same action
5988
	function preserve_action_in_login_form_for_json_api_authorization() {
5989
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5990
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5991
	}
5992
5993
	// If someone logs in to approve API access, store the Access Code in usermeta
5994
	function store_json_api_authorization_token( $user_login, $user ) {
5995
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5996
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5997
		$token = wp_generate_password( 32, false );
5998
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5999
	}
6000
6001
	// Add public-api.wordpress.com to the safe redirect allowed list - only added when someone allows API access.
6002
	function allow_wpcom_public_api_domain( $domains ) {
6003
		$domains[] = 'public-api.wordpress.com';
6004
		return $domains;
6005
	}
6006
6007
	static function is_redirect_encoded( $redirect_url ) {
6008
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
6009
	}
6010
6011
	// Add all wordpress.com environments to the safe redirect allowed list.
6012
	function allow_wpcom_environments( $domains ) {
6013
		$domains[] = 'wordpress.com';
6014
		$domains[] = 'wpcalypso.wordpress.com';
6015
		$domains[] = 'horizon.wordpress.com';
6016
		$domains[] = 'calypso.localhost';
6017
		return $domains;
6018
	}
6019
6020
	// Add the Access Code details to the public-api.wordpress.com redirect
6021
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6022
		return add_query_arg(
6023
			urlencode_deep(
6024
				array(
6025
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6026
					'jetpack-user-id' => (int) $user->ID,
6027
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6028
				)
6029
			),
6030
			$redirect_to
6031
		);
6032
	}
6033
6034
	/**
6035
	 * Verifies the request by checking the signature
6036
	 *
6037
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6038
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6039
	 *
6040
	 * @param null|array $environment
6041
	 */
6042
	function verify_json_api_authorization_request( $environment = null ) {
6043
		$environment = is_null( $environment )
6044
			? $_REQUEST
6045
			: $environment;
6046
6047
		//phpcs:ignore MediaWiki.Classes.UnusedUseStatement.UnusedUse,VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
6048
		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...
6049
		$token = ( new Tokens() )->get_access_token( $env_user_id, $env_token );
6050
		if ( ! $token || empty( $token->secret ) ) {
6051
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
6052
		}
6053
6054
		$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' );
6055
6056
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
6057
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
6058
			/**
6059
			 * Jetpack authorisation request Error.
6060
			 *
6061
			 * @since 7.5.0
6062
			 */
6063
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
6064
			$die_error = sprintf(
6065
				/* translators: %s is a URL */
6066
				__( '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' ),
6067
				Redirect::get_url( 'jetpack-support-double-encoding' )
6068
			);
6069
		}
6070
6071
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6072
6073
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6074
			$signature = $jetpack_signature->sign_request(
6075
				$environment['token'],
6076
				$environment['timestamp'],
6077
				$environment['nonce'],
6078
				'',
6079
				'GET',
6080
				$environment['jetpack_json_api_original_query'],
6081
				null,
6082
				true
6083
			);
6084
		} else {
6085
			$signature = $jetpack_signature->sign_current_request(
6086
				array(
6087
					'body'   => null,
6088
					'method' => 'GET',
6089
				)
6090
			);
6091
		}
6092
6093
		if ( ! $signature ) {
6094
			wp_die( $die_error );
6095
		} elseif ( is_wp_error( $signature ) ) {
6096
			wp_die( $die_error );
6097
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
6098
			if ( is_ssl() ) {
6099
				// 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
6100
				$signature = $jetpack_signature->sign_current_request(
6101
					array(
6102
						'scheme' => 'http',
6103
						'body'   => null,
6104
						'method' => 'GET',
6105
					)
6106
				);
6107
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6108
					wp_die( $die_error );
6109
				}
6110
			} else {
6111
				wp_die( $die_error );
6112
			}
6113
		}
6114
6115
		$timestamp = (int) $environment['timestamp'];
6116
		$nonce     = stripslashes( (string) $environment['nonce'] );
6117
6118
		if ( ! $this->connection_manager ) {
6119
			$this->connection_manager = new Connection_Manager();
6120
		}
6121
6122
		if ( ! ( new Nonce_Handler() )->add( $timestamp, $nonce ) ) {
6123
			// De-nonce the nonce, at least for 5 minutes.
6124
			// 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)
6125
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6126
			if ( $old_nonce_time < time() - 300 ) {
6127
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6128
			}
6129
		}
6130
6131
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6132
		$data_filters = array(
6133
			'state'        => 'opaque',
6134
			'client_id'    => 'int',
6135
			'client_title' => 'string',
6136
			'client_image' => 'url',
6137
		);
6138
6139
		foreach ( $data_filters as $key => $sanitation ) {
6140
			if ( ! isset( $data->$key ) ) {
6141
				wp_die( $die_error );
6142
			}
6143
6144
			switch ( $sanitation ) {
6145
				case 'int':
6146
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6147
					break;
6148
				case 'opaque':
6149
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6150
					break;
6151
				case 'string':
6152
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6153
					break;
6154
				case 'url':
6155
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6156
					break;
6157
			}
6158
		}
6159
6160
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6161
			wp_die( $die_error );
6162
		}
6163
	}
6164
6165
	function login_message_json_api_authorization( $message ) {
6166
		return '<p class="message">' . sprintf(
6167
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6168
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6169
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6170
	}
6171
6172
	/**
6173
	 * Get $content_width, but with a <s>twist</s> filter.
6174
	 */
6175
	public static function get_content_width() {
6176
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6177
			? $GLOBALS['content_width']
6178
			: false;
6179
		/**
6180
		 * Filter the Content Width value.
6181
		 *
6182
		 * @since 2.2.3
6183
		 *
6184
		 * @param string $content_width Content Width value.
6185
		 */
6186
		return apply_filters( 'jetpack_content_width', $content_width );
6187
	}
6188
6189
	/**
6190
	 * Pings the WordPress.com Mirror Site for the specified options.
6191
	 *
6192
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6193
	 *
6194
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6195
	 */
6196
	public function get_cloud_site_options( $option_names ) {
6197
		$option_names = array_filter( (array) $option_names, 'is_string' );
6198
6199
		$xml = new Jetpack_IXR_Client();
6200
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6201
		if ( $xml->isError() ) {
6202
			return array(
6203
				'error_code' => $xml->getErrorCode(),
6204
				'error_msg'  => $xml->getErrorMessage(),
6205
			);
6206
		}
6207
		$cloud_site_options = $xml->getResponse();
6208
6209
		return $cloud_site_options;
6210
	}
6211
6212
	/**
6213
	 * Checks if the site is currently in an identity crisis.
6214
	 *
6215
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6216
	 */
6217
	public static function check_identity_crisis() {
6218
		if ( ! self::is_connection_ready() || ( new Status() )->is_offline_mode() || ! self::validate_sync_error_idc_option() ) {
6219
			return false;
6220
		}
6221
6222
		return Jetpack_Options::get_option( 'sync_error_idc' );
6223
	}
6224
6225
	/**
6226
	 * Checks whether the home and siteurl specifically are allowed.
6227
	 * Written so that we don't have re-check $key and $value params every time
6228
	 * we want to check if this site is allowed, for example in footer.php
6229
	 *
6230
	 * @since  3.8.0
6231
	 * @return bool True = already allowed False = not on the allowed list.
6232
	 */
6233
	public static function is_staging_site() {
6234
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6235
		return ( new Status() )->is_staging_site();
6236
	}
6237
6238
	/**
6239
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6240
	 *
6241
	 * @since 4.4.0
6242
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6243
	 *
6244
	 * @return bool
6245
	 */
6246
	public static function validate_sync_error_idc_option() {
6247
		$is_valid = false;
6248
6249
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6250
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6251
		if ( $sync_error && self::sync_idc_optin() ) {
6252
			$local_options = self::get_sync_error_idc_option();
6253
			// Ensure all values are set.
6254
			if ( isset( $sync_error['home'] ) && isset( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6255
6256
				// If the WP.com expected home and siteurl match local home and siteurl it is not valid IDC.
6257
				if (
6258
						isset( $sync_error['wpcom_home'] ) &&
6259
						isset( $sync_error['wpcom_siteurl'] ) &&
6260
						$sync_error['wpcom_home'] === $local_options['home'] &&
6261
						$sync_error['wpcom_siteurl'] === $local_options['siteurl']
6262
				) {
6263
					$is_valid = false;
6264
					// Enable migrate_for_idc so that sync actions are accepted.
6265
					Jetpack_Options::update_option( 'migrate_for_idc', true );
6266
				} elseif ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6267
					$is_valid = true;
6268
				}
6269
			}
6270
		}
6271
6272
		/**
6273
		 * Filters whether the sync_error_idc option is valid.
6274
		 *
6275
		 * @since 4.4.0
6276
		 *
6277
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6278
		 */
6279
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6280
6281
		if ( ! $is_valid && $sync_error ) {
6282
			// Since the option exists, and did not validate, delete it
6283
			Jetpack_Options::delete_option( 'sync_error_idc' );
6284
		}
6285
6286
		return $is_valid;
6287
	}
6288
6289
	/**
6290
	 * Normalizes a url by doing three things:
6291
	 *  - Strips protocol
6292
	 *  - Strips www
6293
	 *  - Adds a trailing slash
6294
	 *
6295
	 * @since 4.4.0
6296
	 * @param string $url
6297
	 * @return WP_Error|string
6298
	 */
6299
	public static function normalize_url_protocol_agnostic( $url ) {
6300
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6301
		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...
6302
			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...
6303
		}
6304
6305
		// Strip www and protocols
6306
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6307
		return $url;
6308
	}
6309
6310
	/**
6311
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6312
	 *
6313
	 * @since 4.4.0
6314
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6315
	 *
6316
	 * @param array $response
6317
	 * @return array Array of the local urls, wpcom urls, and error code
6318
	 */
6319
	public static function get_sync_error_idc_option( $response = array() ) {
6320
		// Since the local options will hit the database directly, store the values
6321
		// in a transient to allow for autoloading and caching on subsequent views.
6322
		$local_options = get_transient( 'jetpack_idc_local' );
6323
		if ( false === $local_options ) {
6324
			$local_options = array(
6325
				'home'    => Functions::home_url(),
6326
				'siteurl' => Functions::site_url(),
6327
			);
6328
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6329
		}
6330
6331
		$options = array_merge( $local_options, $response );
6332
6333
		$returned_values = array();
6334
		foreach ( $options as $key => $option ) {
6335
			if ( 'error_code' === $key ) {
6336
				$returned_values[ $key ] = $option;
6337
				continue;
6338
			}
6339
6340
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6341
				continue;
6342
			}
6343
6344
			$returned_values[ $key ] = $normalized_url;
6345
		}
6346
6347
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6348
6349
		return $returned_values;
6350
	}
6351
6352
	/**
6353
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6354
	 * If set to true, the site will be put into staging mode.
6355
	 *
6356
	 * @since 4.3.2
6357
	 * @return bool
6358
	 */
6359
	public static function sync_idc_optin() {
6360
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6361
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6362
		} else {
6363
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6364
		}
6365
6366
		/**
6367
		 * Allows sites to opt in for IDC mitigation which blocks the site from syncing to WordPress.com when the home
6368
		 * URL or site URL do not match what WordPress.com expects. The default value is either true, or the value of
6369
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6370
		 *
6371
		 * @since 4.3.2
6372
		 *
6373
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6374
		 */
6375
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6376
	}
6377
6378
	/**
6379
	 * Maybe Use a .min.css stylesheet, maybe not.
6380
	 *
6381
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6382
	 */
6383
	public static function maybe_min_asset( $url, $path, $plugin ) {
6384
		// Short out on things trying to find actual paths.
6385
		if ( ! $path || empty( $plugin ) ) {
6386
			return $url;
6387
		}
6388
6389
		$path = ltrim( $path, '/' );
6390
6391
		// Strip out the abspath.
6392
		$base = dirname( plugin_basename( $plugin ) );
6393
6394
		// Short out on non-Jetpack assets.
6395
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6396
			return $url;
6397
		}
6398
6399
		// File name parsing.
6400
		$file              = "{$base}/{$path}";
6401
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6402
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6403
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6404
		$extension         = array_shift( $file_name_parts_r );
6405
6406
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6407
			// Already pointing at the minified version.
6408
			if ( 'min' === $file_name_parts_r[0] ) {
6409
				return $url;
6410
			}
6411
6412
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6413
			if ( file_exists( $min_full_path ) ) {
6414
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6415
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6416
				if ( 'css' === $extension ) {
6417
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6418
					self::$min_assets[ $key ] = $path;
6419
				}
6420
			}
6421
		}
6422
6423
		return $url;
6424
	}
6425
6426
	/**
6427
	 * If the asset is minified, let's flag .min as the suffix.
6428
	 *
6429
	 * Attached to `style_loader_src` filter.
6430
	 *
6431
	 * @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...
6432
	 * @param string $handle The registered handle of the script in question.
6433
	 * @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...
6434
	 */
6435
	public static function set_suffix_on_min( $src, $handle ) {
6436
		if ( false === strpos( $src, '.min.css' ) ) {
6437
			return $src;
6438
		}
6439
6440
		if ( ! empty( self::$min_assets ) ) {
6441
			foreach ( self::$min_assets as $file => $path ) {
6442
				if ( false !== strpos( $src, $file ) ) {
6443
					wp_style_add_data( $handle, 'suffix', '.min' );
6444
					return $src;
6445
				}
6446
			}
6447
		}
6448
6449
		return $src;
6450
	}
6451
6452
	/**
6453
	 * Maybe inlines a stylesheet.
6454
	 *
6455
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6456
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6457
	 *
6458
	 * Attached to `style_loader_tag` filter.
6459
	 *
6460
	 * @param string $tag The tag that would link to the external asset.
6461
	 * @param string $handle The registered handle of the script in question.
6462
	 *
6463
	 * @return string
6464
	 */
6465
	public static function maybe_inline_style( $tag, $handle ) {
6466
		global $wp_styles;
6467
		$item = $wp_styles->registered[ $handle ];
6468
6469
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6470
			return $tag;
6471
		}
6472
6473
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6474
			$href = $matches[1];
6475
			// Strip off query string
6476
			if ( $pos = strpos( $href, '?' ) ) {
6477
				$href = substr( $href, 0, $pos );
6478
			}
6479
			// Strip off fragment
6480
			if ( $pos = strpos( $href, '#' ) ) {
6481
				$href = substr( $href, 0, $pos );
6482
			}
6483
		} else {
6484
			return $tag;
6485
		}
6486
6487
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6488
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6489
			return $tag;
6490
		}
6491
6492
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6493
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6494
			// And this isn't the pass that actually deals with the RTL version...
6495
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6496
				// Short out, as the RTL version will deal with it in a moment.
6497
				return $tag;
6498
			}
6499
		}
6500
6501
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6502
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6503
		if ( $css ) {
6504
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6505
			if ( empty( $item->extra['after'] ) ) {
6506
				wp_add_inline_style( $handle, $css );
6507
			} else {
6508
				array_unshift( $item->extra['after'], $css );
6509
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6510
			}
6511
		}
6512
6513
		return $tag;
6514
	}
6515
6516
	/**
6517
	 * Loads a view file from the views
6518
	 *
6519
	 * Data passed in with the $data parameter will be available in the
6520
	 * template file as $data['value']
6521
	 *
6522
	 * @param string $template - Template file to load
6523
	 * @param array  $data - Any data to pass along to the template
6524
	 * @return boolean - If template file was found
6525
	 **/
6526
	public function load_view( $template, $data = array() ) {
6527
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6528
6529
		if ( file_exists( $views_dir . $template ) ) {
6530
			require_once $views_dir . $template;
6531
			return true;
6532
		}
6533
6534
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6535
		return false;
6536
	}
6537
6538
	/**
6539
	 * Throws warnings for deprecated hooks to be removed from Jetpack that cannot remain in the original place in the code.
6540
	 */
6541
	public function deprecated_hooks() {
6542
		$filter_deprecated_list = array(
6543
			'jetpack_bail_on_shortcode'                    => array(
6544
				'replacement' => 'jetpack_shortcodes_to_include',
6545
				'version'     => 'jetpack-3.1.0',
6546
			),
6547
			'wpl_sharing_2014_1'                           => array(
6548
				'replacement' => null,
6549
				'version'     => 'jetpack-3.6.0',
6550
			),
6551
			'jetpack-tools-to-include'                     => array(
6552
				'replacement' => 'jetpack_tools_to_include',
6553
				'version'     => 'jetpack-3.9.0',
6554
			),
6555
			'jetpack_identity_crisis_options_to_check'     => array(
6556
				'replacement' => null,
6557
				'version'     => 'jetpack-4.0.0',
6558
			),
6559
			'update_option_jetpack_single_user_site'       => array(
6560
				'replacement' => null,
6561
				'version'     => 'jetpack-4.3.0',
6562
			),
6563
			'audio_player_default_colors'                  => array(
6564
				'replacement' => null,
6565
				'version'     => 'jetpack-4.3.0',
6566
			),
6567
			'add_option_jetpack_featured_images_enabled'   => array(
6568
				'replacement' => null,
6569
				'version'     => 'jetpack-4.3.0',
6570
			),
6571
			'add_option_jetpack_update_details'            => array(
6572
				'replacement' => null,
6573
				'version'     => 'jetpack-4.3.0',
6574
			),
6575
			'add_option_jetpack_updates'                   => array(
6576
				'replacement' => null,
6577
				'version'     => 'jetpack-4.3.0',
6578
			),
6579
			'add_option_jetpack_network_name'              => array(
6580
				'replacement' => null,
6581
				'version'     => 'jetpack-4.3.0',
6582
			),
6583
			'add_option_jetpack_network_allow_new_registrations' => array(
6584
				'replacement' => null,
6585
				'version'     => 'jetpack-4.3.0',
6586
			),
6587
			'add_option_jetpack_network_add_new_users'     => array(
6588
				'replacement' => null,
6589
				'version'     => 'jetpack-4.3.0',
6590
			),
6591
			'add_option_jetpack_network_site_upload_space' => array(
6592
				'replacement' => null,
6593
				'version'     => 'jetpack-4.3.0',
6594
			),
6595
			'add_option_jetpack_network_upload_file_types' => array(
6596
				'replacement' => null,
6597
				'version'     => 'jetpack-4.3.0',
6598
			),
6599
			'add_option_jetpack_network_enable_administration_menus' => array(
6600
				'replacement' => null,
6601
				'version'     => 'jetpack-4.3.0',
6602
			),
6603
			'add_option_jetpack_is_multi_site'             => array(
6604
				'replacement' => null,
6605
				'version'     => 'jetpack-4.3.0',
6606
			),
6607
			'add_option_jetpack_is_main_network'           => array(
6608
				'replacement' => null,
6609
				'version'     => 'jetpack-4.3.0',
6610
			),
6611
			'add_option_jetpack_main_network_site'         => array(
6612
				'replacement' => null,
6613
				'version'     => 'jetpack-4.3.0',
6614
			),
6615
			'jetpack_sync_all_registered_options'          => array(
6616
				'replacement' => null,
6617
				'version'     => 'jetpack-4.3.0',
6618
			),
6619
			'jetpack_has_identity_crisis'                  => array(
6620
				'replacement' => 'jetpack_sync_error_idc_validation',
6621
				'version'     => 'jetpack-4.4.0',
6622
			),
6623
			'jetpack_is_post_mailable'                     => array(
6624
				'replacement' => null,
6625
				'version'     => 'jetpack-4.4.0',
6626
			),
6627
			'jetpack_seo_site_host'                        => array(
6628
				'replacement' => null,
6629
				'version'     => 'jetpack-5.1.0',
6630
			),
6631
			'jetpack_installed_plugin'                     => array(
6632
				'replacement' => 'jetpack_plugin_installed',
6633
				'version'     => 'jetpack-6.0.0',
6634
			),
6635
			'jetpack_holiday_snow_option_name'             => array(
6636
				'replacement' => null,
6637
				'version'     => 'jetpack-6.0.0',
6638
			),
6639
			'jetpack_holiday_chance_of_snow'               => array(
6640
				'replacement' => null,
6641
				'version'     => 'jetpack-6.0.0',
6642
			),
6643
			'jetpack_holiday_snow_js_url'                  => array(
6644
				'replacement' => null,
6645
				'version'     => 'jetpack-6.0.0',
6646
			),
6647
			'jetpack_is_holiday_snow_season'               => array(
6648
				'replacement' => null,
6649
				'version'     => 'jetpack-6.0.0',
6650
			),
6651
			'jetpack_holiday_snow_option_updated'          => array(
6652
				'replacement' => null,
6653
				'version'     => 'jetpack-6.0.0',
6654
			),
6655
			'jetpack_holiday_snowing'                      => array(
6656
				'replacement' => null,
6657
				'version'     => 'jetpack-6.0.0',
6658
			),
6659
			'jetpack_sso_auth_cookie_expirtation'          => array(
6660
				'replacement' => 'jetpack_sso_auth_cookie_expiration',
6661
				'version'     => 'jetpack-6.1.0',
6662
			),
6663
			'jetpack_cache_plans'                          => array(
6664
				'replacement' => null,
6665
				'version'     => 'jetpack-6.1.0',
6666
			),
6667
6668
			'jetpack_lazy_images_skip_image_with_atttributes' => array(
6669
				'replacement' => 'jetpack_lazy_images_skip_image_with_attributes',
6670
				'version'     => 'jetpack-6.5.0',
6671
			),
6672
			'jetpack_enable_site_verification'             => array(
6673
				'replacement' => null,
6674
				'version'     => 'jetpack-6.5.0',
6675
			),
6676
			'can_display_jetpack_manage_notice'            => array(
6677
				'replacement' => null,
6678
				'version'     => 'jetpack-7.3.0',
6679
			),
6680
			'atd_http_post_timeout'                        => array(
6681
				'replacement' => null,
6682
				'version'     => 'jetpack-7.3.0',
6683
			),
6684
			'atd_service_domain'                           => array(
6685
				'replacement' => null,
6686
				'version'     => 'jetpack-7.3.0',
6687
			),
6688
			'atd_load_scripts'                             => array(
6689
				'replacement' => null,
6690
				'version'     => 'jetpack-7.3.0',
6691
			),
6692
			'jetpack_widget_authors_exclude'               => array(
6693
				'replacement' => 'jetpack_widget_authors_params',
6694
				'version'     => 'jetpack-7.7.0',
6695
			),
6696
			// Removed in Jetpack 7.9.0
6697
			'jetpack_pwa_manifest'                         => array(
6698
				'replacement' => null,
6699
				'version'     => 'jetpack-7.9.0',
6700
			),
6701
			'jetpack_pwa_background_color'                 => array(
6702
				'replacement' => null,
6703
				'version'     => 'jetpack-7.9.0',
6704
			),
6705
			'jetpack_check_mobile'                         => array(
6706
				'replacement' => null,
6707
				'version'     => 'jetpack-8.3.0',
6708
			),
6709
			'jetpack_mobile_stylesheet'                    => array(
6710
				'replacement' => null,
6711
				'version'     => 'jetpack-8.3.0',
6712
			),
6713
			'jetpack_mobile_template'                      => array(
6714
				'replacement' => null,
6715
				'version'     => 'jetpack-8.3.0',
6716
			),
6717
			'jetpack_mobile_theme_menu'                    => array(
6718
				'replacement' => null,
6719
				'version'     => 'jetpack-8.3.0',
6720
			),
6721
			'minileven_show_featured_images'               => array(
6722
				'replacement' => null,
6723
				'version'     => 'jetpack-8.3.0',
6724
			),
6725
			'minileven_attachment_size'                    => array(
6726
				'replacement' => null,
6727
				'version'     => 'jetpack-8.3.0',
6728
			),
6729
			'instagram_cache_oembed_api_response_body'     => array(
6730
				'replacement' => null,
6731
				'version'     => 'jetpack-9.1.0',
6732
			),
6733
			'jetpack_can_make_outbound_https'              => array(
6734
				'replacement' => null,
6735
				'version'     => 'jetpack-9.1.0',
6736
			),
6737
		);
6738
6739
		foreach ( $filter_deprecated_list as $tag => $args ) {
6740
			if ( has_filter( $tag ) ) {
6741
				apply_filters_deprecated( $tag, array( null ), $args['version'], $args['replacement'] );
6742
			}
6743
		}
6744
6745
		$action_deprecated_list = array(
6746
			'jetpack_updated_theme'        => array(
6747
				'replacement' => 'jetpack_updated_themes',
6748
				'version'     => 'jetpack-6.2.0',
6749
			),
6750
			'atd_http_post_error'          => array(
6751
				'replacement' => null,
6752
				'version'     => 'jetpack-7.3.0',
6753
			),
6754
			'mobile_reject_mobile'         => array(
6755
				'replacement' => null,
6756
				'version'     => 'jetpack-8.3.0',
6757
			),
6758
			'mobile_force_mobile'          => array(
6759
				'replacement' => null,
6760
				'version'     => 'jetpack-8.3.0',
6761
			),
6762
			'mobile_app_promo_download'    => array(
6763
				'replacement' => null,
6764
				'version'     => 'jetpack-8.3.0',
6765
			),
6766
			'mobile_setup'                 => array(
6767
				'replacement' => null,
6768
				'version'     => 'jetpack-8.3.0',
6769
			),
6770
			'jetpack_mobile_footer_before' => array(
6771
				'replacement' => null,
6772
				'version'     => 'jetpack-8.3.0',
6773
			),
6774
			'wp_mobile_theme_footer'       => array(
6775
				'replacement' => null,
6776
				'version'     => 'jetpack-8.3.0',
6777
			),
6778
			'minileven_credits'            => array(
6779
				'replacement' => null,
6780
				'version'     => 'jetpack-8.3.0',
6781
			),
6782
			'jetpack_mobile_header_before' => array(
6783
				'replacement' => null,
6784
				'version'     => 'jetpack-8.3.0',
6785
			),
6786
			'jetpack_mobile_header_after'  => array(
6787
				'replacement' => null,
6788
				'version'     => 'jetpack-8.3.0',
6789
			),
6790
		);
6791
6792
		foreach ( $action_deprecated_list as $tag => $args ) {
6793
			if ( has_action( $tag ) ) {
6794
				do_action_deprecated( $tag, array(), $args['version'], $args['replacement'] );
6795
			}
6796
		}
6797
	}
6798
6799
	/**
6800
	 * Converts any url in a stylesheet, to the correct absolute url.
6801
	 *
6802
	 * Considerations:
6803
	 *  - Normal, relative URLs     `feh.png`
6804
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6805
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6806
	 *  - Absolute URLs             `http://domain.com/feh.png`
6807
	 *  - Domain root relative URLs `/feh.png`
6808
	 *
6809
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6810
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6811
	 *
6812
	 * @return mixed|string
6813
	 */
6814
	public static function absolutize_css_urls( $css, $css_file_url ) {
6815
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6816
		$css_dir = dirname( $css_file_url );
6817
		$p       = wp_parse_url( $css_dir );
6818
		$domain  = sprintf(
6819
			'%1$s//%2$s%3$s%4$s',
6820
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6821
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6822
			$p['host'],
6823
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6824
		);
6825
6826
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6827
			$find = $replace = array();
6828
			foreach ( $matches as $match ) {
6829
				$url = trim( $match['path'], "'\" \t" );
6830
6831
				// If this is a data url, we don't want to mess with it.
6832
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6833
					continue;
6834
				}
6835
6836
				// If this is an absolute or protocol-agnostic url,
6837
				// we don't want to mess with it.
6838
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6839
					continue;
6840
				}
6841
6842
				switch ( substr( $url, 0, 1 ) ) {
6843
					case '/':
6844
						$absolute = $domain . $url;
6845
						break;
6846
					default:
6847
						$absolute = $css_dir . '/' . $url;
6848
				}
6849
6850
				$find[]    = $match[0];
6851
				$replace[] = sprintf( 'url("%s")', $absolute );
6852
			}
6853
			$css = str_replace( $find, $replace, $css );
6854
		}
6855
6856
		return $css;
6857
	}
6858
6859
	/**
6860
	 * This methods removes all of the registered css files on the front end
6861
	 * from Jetpack in favor of using a single file. In effect "imploding"
6862
	 * all the files into one file.
6863
	 *
6864
	 * Pros:
6865
	 * - Uses only ONE css asset connection instead of 15
6866
	 * - Saves a minimum of 56k
6867
	 * - Reduces server load
6868
	 * - Reduces time to first painted byte
6869
	 *
6870
	 * Cons:
6871
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6872
	 *      should not cause any issues with themes.
6873
	 * - Plugins/themes dequeuing styles no longer do anything. See
6874
	 *      jetpack_implode_frontend_css filter for a workaround
6875
	 *
6876
	 * For some situations developers may wish to disable css imploding and
6877
	 * instead operate in legacy mode where each file loads seperately and
6878
	 * can be edited individually or dequeued. This can be accomplished with
6879
	 * the following line:
6880
	 *
6881
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6882
	 *
6883
	 * @since 3.2
6884
	 **/
6885
	public function implode_frontend_css( $travis_test = false ) {
6886
		$do_implode = true;
6887
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6888
			$do_implode = false;
6889
		}
6890
6891
		// Do not implode CSS when the page loads via the AMP plugin.
6892
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6893
			$do_implode = false;
6894
		}
6895
6896
		/**
6897
		 * Allow CSS to be concatenated into a single jetpack.css file.
6898
		 *
6899
		 * @since 3.2.0
6900
		 *
6901
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6902
		 */
6903
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6904
6905
		// Do not use the imploded file when default behavior was altered through the filter
6906
		if ( ! $do_implode ) {
6907
			return;
6908
		}
6909
6910
		// We do not want to use the imploded file in dev mode, or if not connected
6911
		if ( ( new Status() )->is_offline_mode() || ! self::is_connection_ready() ) {
6912
			if ( ! $travis_test ) {
6913
				return;
6914
			}
6915
		}
6916
6917
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6918
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6919
			return;
6920
		}
6921
6922
		/*
6923
		 * Now we assume Jetpack is connected and able to serve the single
6924
		 * file.
6925
		 *
6926
		 * In the future there will be a check here to serve the file locally
6927
		 * or potentially from the Jetpack CDN
6928
		 *
6929
		 * For now:
6930
		 * - Enqueue a single imploded css file
6931
		 * - Zero out the style_loader_tag for the bundled ones
6932
		 * - Be happy, drink scotch
6933
		 */
6934
6935
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6936
6937
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6938
6939
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6940
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6941
	}
6942
6943
	function concat_remove_style_loader_tag( $tag, $handle ) {
6944
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6945
			$tag = '';
6946
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6947
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6948
			}
6949
		}
6950
6951
		return $tag;
6952
	}
6953
6954
	/**
6955
	 * @deprecated
6956
	 * @see Automattic\Jetpack\Assets\add_aync_script
6957
	 */
6958
	public function script_add_async( $tag, $handle, $src ) {
6959
		_deprecated_function( __METHOD__, 'jetpack-8.6.0' );
6960
	}
6961
6962
	/*
6963
	 * Check the heartbeat data
6964
	 *
6965
	 * Organizes the heartbeat data by severity.  For example, if the site
6966
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6967
	 *
6968
	 * Data will be added to "caution" array, if it either:
6969
	 *  - Out of date Jetpack version
6970
	 *  - Out of date WP version
6971
	 *  - Out of date PHP version
6972
	 *
6973
	 * $return array $filtered_data
6974
	 */
6975
	public static function jetpack_check_heartbeat_data() {
6976
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6977
6978
		$good    = array();
6979
		$caution = array();
6980
		$bad     = array();
6981
6982
		foreach ( $raw_data as $stat => $value ) {
6983
6984
			// Check jetpack version
6985
			if ( 'version' == $stat ) {
6986
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6987
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6988
					continue;
6989
				}
6990
			}
6991
6992
			// Check WP version
6993
			if ( 'wp-version' == $stat ) {
6994
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6995
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6996
					continue;
6997
				}
6998
			}
6999
7000
			// Check PHP version
7001
			if ( 'php-version' == $stat ) {
7002
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
7003
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_PHP_VERSION;
7004
					continue;
7005
				}
7006
			}
7007
7008
			// Check ID crisis
7009
			if ( 'identitycrisis' == $stat ) {
7010
				if ( 'yes' == $value ) {
7011
					$bad[ $stat ] = $value;
7012
					continue;
7013
				}
7014
			}
7015
7016
			// The rest are good :)
7017
			$good[ $stat ] = $value;
7018
		}
7019
7020
		$filtered_data = array(
7021
			'good'    => $good,
7022
			'caution' => $caution,
7023
			'bad'     => $bad,
7024
		);
7025
7026
		return $filtered_data;
7027
	}
7028
7029
	/*
7030
	 * This method is used to organize all options that can be reset
7031
	 * without disconnecting Jetpack.
7032
	 *
7033
	 * It is used in class.jetpack-cli.php to reset options
7034
	 *
7035
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
7036
	 *
7037
	 * @return array of options to delete.
7038
	 */
7039
	public static function get_jetpack_options_for_reset() {
7040
		return Jetpack_Options::get_options_for_reset();
7041
	}
7042
7043
	/*
7044
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
7045
	 * so we can bring them directly to their site in calypso.
7046
	 *
7047
	 * @deprecated 9.2.0 Use Automattic\Jetpack\Status::get_site_suffix
7048
	 *
7049
	 * @param string | url
7050
	 * @return string | url without the guff
7051
	 */
7052
	public static function build_raw_urls( $url ) {
7053
		_deprecated_function( __METHOD__, 'jetpack-9.2.0', 'Automattic\Jetpack\Status::get_site_suffix' );
7054
7055
		return ( new Status() )->get_site_suffix( $url );
7056
	}
7057
7058
	/**
7059
	 * Stores and prints out domains to prefetch for page speed optimization.
7060
	 *
7061
	 * @deprecated 8.8.0 Use Jetpack::add_resource_hints.
7062
	 *
7063
	 * @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...
7064
	 */
7065
	public static function dns_prefetch( $urls = null ) {
7066
		_deprecated_function( __FUNCTION__, 'jetpack-8.8.0', 'Automattic\Jetpack\Assets::add_resource_hint' );
7067
		if ( $urls ) {
7068
			Assets::add_resource_hint( $urls );
7069
		}
7070
	}
7071
7072
	public function wp_dashboard_setup() {
7073
		if ( self::is_connection_ready() ) {
7074
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
7075
		}
7076
7077
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
7078
			$jetpack_logo = new Jetpack_Logo();
7079
			$widget_title = sprintf(
7080
				/* translators: Placeholder is a Jetpack logo. */
7081
				__( 'Stats by %s', 'jetpack' ),
7082
				$jetpack_logo->get_jp_emblem( true )
7083
			);
7084
7085
			// Wrap title in span so Logo can be properly styled.
7086
			$widget_title = sprintf(
7087
				'<span>%s</span>',
7088
				$widget_title
7089
			);
7090
7091
			wp_add_dashboard_widget(
7092
				'jetpack_summary_widget',
7093
				$widget_title,
7094
				array( __CLASS__, 'dashboard_widget' )
7095
			);
7096
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
7097
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
7098
7099
			// If we're inactive and not in offline mode, sort our box to the top.
7100
			if ( ! self::is_connection_ready() && ! ( new Status() )->is_offline_mode() ) {
7101
				global $wp_meta_boxes;
7102
7103
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
7104
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
7105
7106
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
7107
			}
7108
		}
7109
	}
7110
7111
	/**
7112
	 * @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...
7113
	 * @return mixed
7114
	 */
7115
	function get_user_option_meta_box_order_dashboard( $sorted ) {
7116
		if ( ! is_array( $sorted ) ) {
7117
			return $sorted;
7118
		}
7119
7120
		foreach ( $sorted as $box_context => $ids ) {
7121
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
7122
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
7123
				continue;
7124
			}
7125
7126
			$ids_array = explode( ',', $ids );
7127
			$key       = array_search( 'dashboard_stats', $ids_array );
7128
7129
			if ( false !== $key ) {
7130
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7131
				$ids_array[ $key ]      = 'jetpack_summary_widget';
7132
				$sorted[ $box_context ] = implode( ',', $ids_array );
7133
				// We've found it, stop searching, and just return.
7134
				break;
7135
			}
7136
		}
7137
7138
		return $sorted;
7139
	}
7140
7141
	public static function dashboard_widget() {
7142
		/**
7143
		 * Fires when the dashboard is loaded.
7144
		 *
7145
		 * @since 3.4.0
7146
		 */
7147
		do_action( 'jetpack_dashboard_widget' );
7148
	}
7149
7150
	public static function dashboard_widget_footer() {
7151
		?>
7152
		<footer>
7153
7154
		<div class="protect">
7155
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
7156
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
7157
				<p class="blocked-count">
7158
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
7159
				</p>
7160
				<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>
7161
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_offline_mode() ) : ?>
7162
				<a href="
7163
				<?php
7164
				echo esc_url(
7165
					wp_nonce_url(
7166
						self::admin_url(
7167
							array(
7168
								'action' => 'activate',
7169
								'module' => 'protect',
7170
							)
7171
						),
7172
						'jetpack_activate-protect'
7173
					)
7174
				);
7175
				?>
7176
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
7177
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
7178
				</a>
7179
			<?php else : ?>
7180
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
7181
			<?php endif; ?>
7182
		</div>
7183
7184
		<div class="akismet">
7185
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
7186
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7187
				<p class="blocked-count">
7188
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
7189
				</p>
7190
				<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>
7191
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7192
				<a href="
7193
				<?php
7194
				echo esc_url(
7195
					wp_nonce_url(
7196
						add_query_arg(
7197
							array(
7198
								'action' => 'activate',
7199
								'plugin' => 'akismet/akismet.php',
7200
							),
7201
							admin_url( 'plugins.php' )
7202
						),
7203
						'activate-plugin_akismet/akismet.php'
7204
					)
7205
				);
7206
				?>
7207
							" class="button button-jetpack">
7208
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
7209
				</a>
7210
			<?php else : ?>
7211
				<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>
7212
			<?php endif; ?>
7213
		</div>
7214
7215
		</footer>
7216
		<?php
7217
	}
7218
7219
	/*
7220
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7221
	 */
7222
	function jetpack_icon_user_connected( $columns ) {
7223
		$columns['user_jetpack'] = '';
7224
		return $columns;
7225
	}
7226
7227
	/*
7228
	 * Show Jetpack icon if the user is linked.
7229
	 */
7230
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7231
		if ( 'user_jetpack' === $col && self::connection()->is_user_connected( $user_id ) ) {
7232
			$jetpack_logo = new Jetpack_Logo();
7233
			$emblem_html  = sprintf(
7234
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7235
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7236
				$jetpack_logo->get_jp_emblem()
7237
			);
7238
			return $emblem_html;
7239
		}
7240
7241
		return $val;
7242
	}
7243
7244
	/*
7245
	 * Style the Jetpack user column
7246
	 */
7247
	function jetpack_user_col_style() {
7248
		global $current_screen;
7249
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7250
			?>
7251
			<style>
7252
				.fixed .column-user_jetpack {
7253
					width: 21px;
7254
				}
7255
				.jp-emblem-user-admin svg {
7256
					width: 20px;
7257
					height: 20px;
7258
				}
7259
				.jp-emblem-user-admin path {
7260
					fill: #00BE28;
7261
				}
7262
			</style>
7263
			<?php
7264
		}
7265
	}
7266
7267
	/**
7268
	 * Checks if Akismet is active and working.
7269
	 *
7270
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7271
	 * that implied usage of methods present since more recent version.
7272
	 * See https://github.com/Automattic/jetpack/pull/9585
7273
	 *
7274
	 * @since  5.1.0
7275
	 *
7276
	 * @return bool True = Akismet available. False = Aksimet not available.
7277
	 */
7278
	public static function is_akismet_active() {
7279
		static $status = null;
7280
7281
		if ( ! is_null( $status ) ) {
7282
			return $status;
7283
		}
7284
7285
		// Check if a modern version of Akismet is active.
7286
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7287
			$status = false;
7288
			return $status;
7289
		}
7290
7291
		// Make sure there is a key known to Akismet at all before verifying key.
7292
		$akismet_key = Akismet::get_api_key();
7293
		if ( ! $akismet_key ) {
7294
			$status = false;
7295
			return $status;
7296
		}
7297
7298
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7299
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7300
7301
		// 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.
7302
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7303
		// We cache the result of the Akismet key verification for ten minutes.
7304
		if ( ! $akismet_key_state || $recheck ) {
7305
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7306
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7307
		}
7308
7309
		$status = 'valid' === $akismet_key_state;
7310
7311
		return $status;
7312
	}
7313
7314
	/**
7315
	 * @deprecated
7316
	 *
7317
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7318
	 */
7319
	public static function is_function_in_backtrace() {
7320
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7321
	}
7322
7323
	/**
7324
	 * Given a minified path, and a non-minified path, will return
7325
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7326
	 *
7327
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7328
	 * root Jetpack directory.
7329
	 *
7330
	 * @since 5.6.0
7331
	 *
7332
	 * @param string $min_path
7333
	 * @param string $non_min_path
7334
	 * @return string The URL to the file
7335
	 */
7336
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7337
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7338
	}
7339
7340
	/**
7341
	 * Checks for whether Jetpack Backup is enabled.
7342
	 * Will return true if the state of Backup is anything except "unavailable".
7343
	 *
7344
	 * @return bool|int|mixed
7345
	 */
7346
	public static function is_rewind_enabled() {
7347
		// Rewind is a paid feature, therefore requires a user-level connection.
7348
		if ( ! static::connection()->has_connected_owner() ) {
7349
			return false;
7350
		}
7351
7352
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7353
		if ( false === $rewind_enabled ) {
7354
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7355
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7356
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7357
				&& ! empty( $rewind_data['state'] )
7358
				&& 'active' === $rewind_data['state'] )
7359
				? 1
7360
				: 0;
7361
7362
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7363
		}
7364
		return $rewind_enabled;
7365
	}
7366
7367
	/**
7368
	 * Return Calypso environment value; used for developing Jetpack and pairing
7369
	 * it with different Calypso enrionments, such as localhost.
7370
	 *
7371
	 * @since 7.4.0
7372
	 *
7373
	 * @return string Calypso environment
7374
	 */
7375
	public static function get_calypso_env() {
7376
		if ( isset( $_GET['calypso_env'] ) ) {
7377
			return sanitize_key( $_GET['calypso_env'] );
7378
		}
7379
7380
		if ( getenv( 'CALYPSO_ENV' ) ) {
7381
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7382
		}
7383
7384
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7385
			return sanitize_key( CALYPSO_ENV );
7386
		}
7387
7388
		return '';
7389
	}
7390
7391
	/**
7392
	 * Returns the hostname with protocol for Calypso.
7393
	 * Used for developing Jetpack with Calypso.
7394
	 *
7395
	 * @since 8.4.0
7396
	 *
7397
	 * @return string Calypso host.
7398
	 */
7399
	public static function get_calypso_host() {
7400
		$calypso_env = self::get_calypso_env();
7401
		switch ( $calypso_env ) {
7402
			case 'development':
7403
				return 'http://calypso.localhost:3000/';
7404
			case 'wpcalypso':
7405
				return 'https://wpcalypso.wordpress.com/';
7406
			case 'horizon':
7407
				return 'https://horizon.wordpress.com/';
7408
			default:
7409
				return 'https://wordpress.com/';
7410
		}
7411
	}
7412
7413
	/**
7414
	 * Handles activating default modules as well general cleanup for the new connection.
7415
	 *
7416
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7417
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7418
	 * @param boolean $send_state_messages          Whether to send state messages.
7419
	 * @return void
7420
	 */
7421
	public static function handle_post_authorization_actions(
7422
		$activate_sso = false,
7423
		$redirect_on_activation_error = false,
7424
		$send_state_messages = true
7425
	) {
7426
		$other_modules = $activate_sso
7427
			? array( 'sso' )
7428
			: array();
7429
7430
		if ( Jetpack_Options::get_option( 'active_modules_initialized' ) ) {
7431
			$active_modules = Jetpack_Options::get_option( 'active_modules' );
7432
			self::delete_active_modules();
7433
7434
			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...
7435
		} else {
7436
			// Default modules that don't require a user were already activated on site_register.
7437
			// 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.
7438
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages, null, true );
7439
			Jetpack_Options::update_option( 'active_modules_initialized', true );
7440
		}
7441
7442
		// Since this is a fresh connection, be sure to clear out IDC options
7443
		Jetpack_IDC::clear_all_idc_options();
7444
7445
		if ( $send_state_messages ) {
7446
			self::state( 'message', 'authorized' );
7447
		}
7448
	}
7449
7450
	/**
7451
	 * Returns a boolean for whether backups UI should be displayed or not.
7452
	 *
7453
	 * @return bool Should backups UI be displayed?
7454
	 */
7455
	public static function show_backups_ui() {
7456
		/**
7457
		 * Whether UI for backups should be displayed.
7458
		 *
7459
		 * @since 6.5.0
7460
		 *
7461
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7462
		 */
7463
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7464
	}
7465
7466
	/*
7467
	 * Deprecated manage functions
7468
	 */
7469
	function prepare_manage_jetpack_notice() {
7470
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7471
	}
7472
	function manage_activate_screen() {
7473
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7474
	}
7475
	function admin_jetpack_manage_notice() {
7476
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7477
	}
7478
	function opt_out_jetpack_manage_url() {
7479
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7480
	}
7481
	function opt_in_jetpack_manage_url() {
7482
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7483
	}
7484
	function opt_in_jetpack_manage_notice() {
7485
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7486
	}
7487
	function can_display_jetpack_manage_notice() {
7488
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7489
	}
7490
7491
	/**
7492
	 * Clean leftoveruser meta.
7493
	 *
7494
	 * Delete Jetpack-related user meta when it is no longer needed.
7495
	 *
7496
	 * @since 7.3.0
7497
	 *
7498
	 * @param int $user_id User ID being updated.
7499
	 */
7500
	public static function user_meta_cleanup( $user_id ) {
7501
		$meta_keys = array(
7502
			// AtD removed from Jetpack 7.3
7503
			'AtD_options',
7504
			'AtD_check_when',
7505
			'AtD_guess_lang',
7506
			'AtD_ignored_phrases',
7507
		);
7508
7509
		foreach ( $meta_keys as $meta_key ) {
7510
			if ( get_user_meta( $user_id, $meta_key ) ) {
7511
				delete_user_meta( $user_id, $meta_key );
7512
			}
7513
		}
7514
	}
7515
7516
	/**
7517
	 * Checks if a Jetpack site is both active and not in offline mode.
7518
	 *
7519
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_offline_mode`.
7520
	 *
7521
	 * @deprecated 8.8.0
7522
	 *
7523
	 * @return bool True if Jetpack is active and not in offline mode.
7524
	 */
7525
	public static function is_active_and_not_development_mode() {
7526
		_deprecated_function( __FUNCTION__, 'jetpack-8.8.0', 'Jetpack::is_active_and_not_offline_mode' );
7527
		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...
7528
			return false;
7529
		}
7530
		return true;
7531
	}
7532
7533
	/**
7534
	 * Checks if a Jetpack site is both active and not in offline mode.
7535
	 *
7536
	 * This is a DRY function to avoid repeating `Jetpack::is_connection_ready && ! Automattic\Jetpack\Status->is_offline_mode`.
7537
	 *
7538
	 * @since 8.8.0
7539
	 *
7540
	 * @return bool True if Jetpack is active and not in offline mode.
7541
	 */
7542
	public static function is_active_and_not_offline_mode() {
7543
		if ( ! self::is_connection_ready() || ( new Status() )->is_offline_mode() ) {
7544
			return false;
7545
		}
7546
		return true;
7547
	}
7548
7549
	/**
7550
	 * Returns the list of products that we have available for purchase.
7551
	 */
7552
	public static function get_products_for_purchase() {
7553
		$products = array();
7554
		if ( ! is_multisite() ) {
7555
			$products[] = array(
7556
				'key'               => 'backup',
7557
				'title'             => __( 'Jetpack Backup', 'jetpack' ),
7558
				'short_description' => __( 'Always-on backups ensure you never lose your site.', 'jetpack' ),
7559
				'learn_more'        => __( 'Which backup option is best for me?', 'jetpack' ),
7560
				'description'       => __( 'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.', 'jetpack' ),
7561
				'options_label'     => __( 'Select a backup option:', 'jetpack' ),
7562
				'options'           => array(
7563
					array(
7564
						'type'        => 'daily',
7565
						'slug'        => 'jetpack-backup-daily',
7566
						'key'         => 'jetpack_backup_daily',
7567
						'name'        => __( 'Daily Backups', 'jetpack' ),
7568
						'description' => __( 'Your data is being securely backed up daily.', 'jetpack' ),
7569
					),
7570
					array(
7571
						'type'        => 'realtime',
7572
						'slug'        => 'jetpack-backup-realtime',
7573
						'key'         => 'jetpack_backup_realtime',
7574
						'name'        => __( 'Real-Time Backups', 'jetpack' ),
7575
						'description' => __( 'Your data is being securely backed up as you edit.', 'jetpack' ),
7576
					),
7577
				),
7578
				'default_option'    => 'realtime',
7579
				'show_promotion'    => true,
7580
				'discount_percent'  => 70,
7581
				'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'daily-backup-plan', 'realtime-backup-plan' ),
7582
			);
7583
7584
			$products[] = array(
7585
				'key'               => 'scan',
7586
				'title'             => __( 'Jetpack Scan', 'jetpack' ),
7587
				'short_description' => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7588
				'learn_more'        => __( 'Learn More', 'jetpack' ),
7589
				'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7590
				'show_promotion'    => true,
7591
				'discount_percent'  => 30,
7592
				'options'           => array(
7593
					array(
7594
						'type' => 'scan',
7595
						'slug' => 'jetpack-scan',
7596
						'key'  => 'jetpack_scan',
7597
						'name' => __( 'Daily Scan', 'jetpack' ),
7598
					),
7599
				),
7600
				'default_option'    => 'scan',
7601
				'included_in_plans' => array( 'premium-plan', 'business-plan', 'scan-plan' ),
7602
			);
7603
		}
7604
7605
		$products[] = array(
7606
			'key'               => 'search',
7607
			'title'             => __( 'Jetpack Search', 'jetpack' ),
7608
			'short_description' => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7609
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7610
			'description'       => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7611
			'label_popup'       => __( 'Records are all posts, pages, custom post types, and other types of content indexed by Jetpack Search.', 'jetpack' ),
7612
			'options'           => array(
7613
				array(
7614
					'type' => 'search',
7615
					'slug' => 'jetpack-search',
7616
					'key'  => 'jetpack_search',
7617
					'name' => __( 'Search', 'jetpack' ),
7618
				),
7619
			),
7620
			'tears'             => array(),
7621
			'default_option'    => 'search',
7622
			'show_promotion'    => false,
7623
			'included_in_plans' => array( 'search-plan' ),
7624
		);
7625
7626
		$products[] = array(
7627
			'key'               => 'anti-spam',
7628
			'title'             => __( 'Jetpack Anti-Spam', 'jetpack' ),
7629
			'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' ),
7630
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7631
			'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' ),
7632
			'options'           => array(
7633
				array(
7634
					'type' => 'anti-spam',
7635
					'slug' => 'jetpack-anti-spam',
7636
					'key'  => 'jetpack_anti_spam',
7637
					'name' => __( 'Anti-Spam', 'jetpack' ),
7638
				),
7639
			),
7640
			'default_option'    => 'anti-spam',
7641
			'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'anti-spam-plan' ),
7642
		);
7643
7644
		return $products;
7645
	}
7646
}
7647