Completed
Push — add/segmentation_params_to_reg... ( f41ace...11aa8b )
by
unknown
12:28 queued 11s
created

Jetpack::admin_init()   C

Complexity

Conditions 12
Paths 32

Size

Total Lines 49

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 12
nc 32
nop 0
dl 0
loc 49
rs 6.9666
c 0
b 0
f 0

How to fix   Complexity   

Long Method

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

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

Commonly applied refactorings include:

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
1731
	}
1732
1733
	/**
1734
	 * Returns true if the current site is connected to WordPress.com and has the minimum requirements to enable Jetpack UI
1735
	 *
1736
	 * This method was introduced just before the release of the possibility to use Jetpack without a user connection, while
1737
	 * it was available only when no_user_testing_mode was enabled. In the near future, this will return is_connected for all
1738
	 * users and this option will be available by default for everybody.
1739
	 *
1740
	 * @since 9.6.0
1741
	 * @since 9.7.0 returns is_connected in all cases and adds filter to the returned value
1742
	 *
1743
	 * @return bool is the site connection ready to be used?
1744
	 */
1745
	public static function is_connection_ready() {
1746
		/**
1747
		 * Allows filtering whether the connection is ready to be used. If true, this will enable the Jetpack UI and modules
1748
		 *
1749
		 * Modules will be enabled depending on the connection status and if the module requires a connection or user connection.
1750
		 *
1751
		 * @since 9.7.0
1752
		 *
1753
		 * @param bool                                  $is_connection_ready Is the connection ready?
1754
		 * @param Automattic\Jetpack\Connection\Manager $connection_manager Instance of the Manager class, can be used to check the connection status.
1755
		 */
1756
		return apply_filters( 'jetpack_is_connection_ready', self::connection()->is_connected(), self::connection() );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with self::connection().

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