Completed
Push — instant-search-master ( 95535d...2c1eb1 )
by
unknown
22:37 queued 16:04
created

Jetpack::__construct()   B

Complexity

Conditions 4
Paths 8

Size

Total Lines 131

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
nc 8
nop 0
dl 0
loc 131
rs 8
c 0
b 0
f 0

How to fix   Long Method   

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

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...
1550
	}
1551
1552
	/**
1553
	 * Make an API call to WordPress.com for plan status
1554
	 *
1555
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1556
	 *
1557
	 * @return bool True if plan is updated, false if no update
1558
	 */
1559
	public static function refresh_active_plan_from_wpcom() {
1560
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1561
		return Jetpack_Plan::refresh_from_wpcom();
1562
	}
1563
1564
	/**
1565
	 * Get the plan that this Jetpack site is currently using
1566
	 *
1567
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1568
	 * @return array Active Jetpack plan details.
1569
	 */
1570
	public static function get_active_plan() {
1571
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1572
		return Jetpack_Plan::get();
1573
	}
1574
1575
	/**
1576
	 * Determine whether the active plan supports a particular feature
1577
	 *
1578
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1579
	 * @return bool True if plan supports feature, false if not.
1580
	 */
1581
	public static function active_plan_supports( $feature ) {
1582
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1583
		return Jetpack_Plan::supports( $feature );
1584
	}
1585
1586
	/**
1587
	 * Deprecated: Is Jetpack in development (offline) mode?
1588
	 *
1589
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1590
	 * and themes still use it, and we do not want to flood them with notices.
1591
	 *
1592
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1593
	 *
1594
	 * @deprecated since 8.0.
1595
	 */
1596
	public static function is_development_mode() {
1597
		return ( new Status() )->is_development_mode();
1598
	}
1599
1600
	/**
1601
	 * Whether the site is currently onboarding or not.
1602
	 * A site is considered as being onboarded if it currently has an onboarding token.
1603
	 *
1604
	 * @since 5.8
1605
	 *
1606
	 * @access public
1607
	 * @static
1608
	 *
1609
	 * @return bool True if the site is currently onboarding, false otherwise
1610
	 */
1611
	public static function is_onboarding() {
1612
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1613
	}
1614
1615
	/**
1616
	 * Determines reason for Jetpack development mode.
1617
	 */
1618
	public static function development_mode_trigger_text() {
1619
		if ( ! ( new Status() )->is_development_mode() ) {
1620
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1621
		}
1622
1623
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1624
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1625
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1626
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1627
		} else {
1628
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1629
		}
1630
1631
		return $notice;
1632
1633
	}
1634
	/**
1635
	 * Get Jetpack development mode notice text and notice class.
1636
	 *
1637
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1638
	 */
1639
	public static function show_development_mode_notice() {
1640 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1641
			$notice = sprintf(
1642
				/* translators: %s is a URL */
1643
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1644
				'https://jetpack.com/support/development-mode/'
1645
			);
1646
1647
			$notice .= ' ' . self::development_mode_trigger_text();
1648
1649
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1650
		}
1651
1652
		// Throw up a notice if using a development version and as for feedback.
1653
		if ( self::is_development_version() ) {
1654
			/* translators: %s is a URL */
1655
			$notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), 'https://jetpack.com/contact-support/beta-group/' );
1656
1657
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1658
		}
1659
		// Throw up a notice if using staging mode
1660
		if ( ( new Status() )->is_staging_site() ) {
1661
			/* translators: %s is a URL */
1662
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1663
1664
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1665
		}
1666
	}
1667
1668
	/**
1669
	 * Whether Jetpack's version maps to a public release, or a development version.
1670
	 */
1671
	public static function is_development_version() {
1672
		/**
1673
		 * Allows filtering whether this is a development version of Jetpack.
1674
		 *
1675
		 * This filter is especially useful for tests.
1676
		 *
1677
		 * @since 4.3.0
1678
		 *
1679
		 * @param bool $development_version Is this a develoment version of Jetpack?
1680
		 */
1681
		return (bool) apply_filters(
1682
			'jetpack_development_version',
1683
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1684
		);
1685
	}
1686
1687
	/**
1688
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1689
	 */
1690
	public static function is_user_connected( $user_id = false ) {
1691
		return self::connection()->is_user_connected( $user_id );
1692
	}
1693
1694
	/**
1695
	 * Get the wpcom user data of the current|specified connected user.
1696
	 */
1697 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1698
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1699
		if ( ! $user_id ) {
1700
			$user_id = get_current_user_id();
1701
		}
1702
1703
		$transient_key = "jetpack_connected_user_data_$user_id";
1704
1705
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1706
			return $cached_user_data;
1707
		}
1708
1709
		$xml = new Jetpack_IXR_Client(
1710
			array(
1711
				'user_id' => $user_id,
1712
			)
1713
		);
1714
		$xml->query( 'wpcom.getUser' );
1715
		if ( ! $xml->isError() ) {
1716
			$user_data = $xml->getResponse();
1717
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1718
			return $user_data;
1719
		}
1720
1721
		return false;
1722
	}
1723
1724
	/**
1725
	 * Get the wpcom email of the current|specified connected user.
1726
	 */
1727 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1728
		if ( ! $user_id ) {
1729
			$user_id = get_current_user_id();
1730
		}
1731
1732
		$xml = new Jetpack_IXR_Client(
1733
			array(
1734
				'user_id' => $user_id,
1735
			)
1736
		);
1737
		$xml->query( 'wpcom.getUserEmail' );
1738
		if ( ! $xml->isError() ) {
1739
			return $xml->getResponse();
1740
		}
1741
		return false;
1742
	}
1743
1744
	/**
1745
	 * Get the wpcom email of the master user.
1746
	 */
1747
	public static function get_master_user_email() {
1748
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1749
		if ( $master_user_id ) {
1750
			return self::get_connected_user_email( $master_user_id );
1751
		}
1752
		return '';
1753
	}
1754
1755
	/**
1756
	 * Whether the current user is the connection owner.
1757
	 *
1758
	 * @deprecated since 7.7
1759
	 *
1760
	 * @return bool Whether the current user is the connection owner.
1761
	 */
1762
	public function current_user_is_connection_owner() {
1763
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1764
		return self::connection()->is_connection_owner();
1765
	}
1766
1767
	/**
1768
	 * Gets current user IP address.
1769
	 *
1770
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1771
	 *
1772
	 * @return string                  Current user IP address.
1773
	 */
1774
	public static function current_user_ip( $check_all_headers = false ) {
1775
		if ( $check_all_headers ) {
1776
			foreach ( array(
1777
				'HTTP_CF_CONNECTING_IP',
1778
				'HTTP_CLIENT_IP',
1779
				'HTTP_X_FORWARDED_FOR',
1780
				'HTTP_X_FORWARDED',
1781
				'HTTP_X_CLUSTER_CLIENT_IP',
1782
				'HTTP_FORWARDED_FOR',
1783
				'HTTP_FORWARDED',
1784
				'HTTP_VIA',
1785
			) as $key ) {
1786
				if ( ! empty( $_SERVER[ $key ] ) ) {
1787
					return $_SERVER[ $key ];
1788
				}
1789
			}
1790
		}
1791
1792
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1793
	}
1794
1795
	/**
1796
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1797
	 */
1798
	function extra_oembed_providers() {
1799
		// Cloudup: https://dev.cloudup.com/#oembed
1800
		wp_oembed_add_provider( 'https://cloudup.com/*', 'https://cloudup.com/oembed' );
1801
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1802
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1803
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1804
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1805
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1806
		wp_oembed_add_provider( 'https://song.link/*', 'https://song.link/oembed', false );
1807
	}
1808
1809
	/**
1810
	 * Synchronize connected user role changes
1811
	 */
1812
	function user_role_change( $user_id ) {
1813
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1814
		Users::user_role_change( $user_id );
1815
	}
1816
1817
	/**
1818
	 * Loads the currently active modules.
1819
	 */
1820
	public static function load_modules() {
1821
		$is_development_mode = ( new Status() )->is_development_mode();
1822
		if (
1823
			! self::is_active()
1824
			&& ! $is_development_mode
1825
			&& ! self::is_onboarding()
1826
			&& (
1827
				! is_multisite()
1828
				|| ! get_site_option( 'jetpack_protect_active' )
1829
			)
1830
		) {
1831
			return;
1832
		}
1833
1834
		$version = Jetpack_Options::get_option( 'version' );
1835 View Code Duplication
		if ( ! $version ) {
1836
			$version = $old_version = JETPACK__VERSION . ':' . time();
1837
			/** This action is documented in class.jetpack.php */
1838
			do_action( 'updating_jetpack_version', $version, false );
1839
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1840
		}
1841
		list( $version ) = explode( ':', $version );
1842
1843
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1844
1845
		$modules_data = array();
1846
1847
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1848
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1849
			$updated_modules = array();
1850
			foreach ( $modules as $module ) {
1851
				$modules_data[ $module ] = self::get_module( $module );
1852
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1853
					continue;
1854
				}
1855
1856
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1857
					continue;
1858
				}
1859
1860
				$updated_modules[] = $module;
1861
			}
1862
1863
			$modules = array_diff( $modules, $updated_modules );
1864
		}
1865
1866
		foreach ( $modules as $index => $module ) {
1867
			// If we're in dev mode, disable modules requiring a connection
1868
			if ( $is_development_mode ) {
1869
				// Prime the pump if we need to
1870
				if ( empty( $modules_data[ $module ] ) ) {
1871
					$modules_data[ $module ] = self::get_module( $module );
1872
				}
1873
				// If the module requires a connection, but we're in local mode, don't include it.
1874
				if ( $modules_data[ $module ]['requires_connection'] ) {
1875
					continue;
1876
				}
1877
			}
1878
1879
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1880
				continue;
1881
			}
1882
1883
			if ( ! include_once self::get_module_path( $module ) ) {
1884
				unset( $modules[ $index ] );
1885
				self::update_active_modules( array_values( $modules ) );
1886
				continue;
1887
			}
1888
1889
			/**
1890
			 * Fires when a specific module is loaded.
1891
			 * The dynamic part of the hook, $module, is the module slug.
1892
			 *
1893
			 * @since 1.1.0
1894
			 */
1895
			do_action( 'jetpack_module_loaded_' . $module );
1896
		}
1897
1898
		/**
1899
		 * Fires when all the modules are loaded.
1900
		 *
1901
		 * @since 1.1.0
1902
		 */
1903
		do_action( 'jetpack_modules_loaded' );
1904
1905
		// 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.
1906
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1907
	}
1908
1909
	/**
1910
	 * Check if Jetpack's REST API compat file should be included
1911
	 *
1912
	 * @action plugins_loaded
1913
	 * @return null
1914
	 */
1915
	public function check_rest_api_compat() {
1916
		/**
1917
		 * Filters the list of REST API compat files to be included.
1918
		 *
1919
		 * @since 2.2.5
1920
		 *
1921
		 * @param array $args Array of REST API compat files to include.
1922
		 */
1923
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1924
1925
		if ( function_exists( 'bbpress' ) ) {
1926
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1927
		}
1928
1929
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1930
			require_once $_jetpack_rest_api_compat_include;
1931
		}
1932
	}
1933
1934
	/**
1935
	 * Gets all plugins currently active in values, regardless of whether they're
1936
	 * traditionally activated or network activated.
1937
	 *
1938
	 * @todo Store the result in core's object cache maybe?
1939
	 */
1940
	public static function get_active_plugins() {
1941
		$active_plugins = (array) get_option( 'active_plugins', array() );
1942
1943
		if ( is_multisite() ) {
1944
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1945
			// whereas active_plugins stores them in the values.
1946
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1947
			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...
1948
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1949
			}
1950
		}
1951
1952
		sort( $active_plugins );
1953
1954
		return array_unique( $active_plugins );
1955
	}
1956
1957
	/**
1958
	 * Gets and parses additional plugin data to send with the heartbeat data
1959
	 *
1960
	 * @since 3.8.1
1961
	 *
1962
	 * @return array Array of plugin data
1963
	 */
1964
	public static function get_parsed_plugin_data() {
1965
		if ( ! function_exists( 'get_plugins' ) ) {
1966
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
1967
		}
1968
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1969
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1970
		$active_plugins = self::get_active_plugins();
1971
1972
		$plugins = array();
1973
		foreach ( $all_plugins as $path => $plugin_data ) {
1974
			$plugins[ $path ] = array(
1975
				'is_active' => in_array( $path, $active_plugins ),
1976
				'file'      => $path,
1977
				'name'      => $plugin_data['Name'],
1978
				'version'   => $plugin_data['Version'],
1979
				'author'    => $plugin_data['Author'],
1980
			);
1981
		}
1982
1983
		return $plugins;
1984
	}
1985
1986
	/**
1987
	 * Gets and parses theme data to send with the heartbeat data
1988
	 *
1989
	 * @since 3.8.1
1990
	 *
1991
	 * @return array Array of theme data
1992
	 */
1993
	public static function get_parsed_theme_data() {
1994
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
1995
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1996
1997
		$themes = array();
1998
		foreach ( $all_themes as $slug => $theme_data ) {
1999
			$theme_headers = array();
2000
			foreach ( $header_keys as $header_key ) {
2001
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2002
			}
2003
2004
			$themes[ $slug ] = array(
2005
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2006
				'slug'            => $slug,
2007
				'theme_root'      => $theme_data->get_theme_root_uri(),
2008
				'parent'          => $theme_data->parent(),
2009
				'headers'         => $theme_headers,
2010
			);
2011
		}
2012
2013
		return $themes;
2014
	}
2015
2016
	/**
2017
	 * Checks whether a specific plugin is active.
2018
	 *
2019
	 * We don't want to store these in a static variable, in case
2020
	 * there are switch_to_blog() calls involved.
2021
	 */
2022
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2023
		return in_array( $plugin, self::get_active_plugins() );
2024
	}
2025
2026
	/**
2027
	 * Check if Jetpack's Open Graph tags should be used.
2028
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2029
	 *
2030
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2031
	 * @action plugins_loaded
2032
	 * @return null
2033
	 */
2034
	public function check_open_graph() {
2035
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2036
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2037
		}
2038
2039
		$active_plugins = self::get_active_plugins();
2040
2041
		if ( ! empty( $active_plugins ) ) {
2042
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2043
				if ( in_array( $plugin, $active_plugins ) ) {
2044
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2045
					break;
2046
				}
2047
			}
2048
		}
2049
2050
		/**
2051
		 * Allow the addition of Open Graph Meta Tags to all pages.
2052
		 *
2053
		 * @since 2.0.3
2054
		 *
2055
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2056
		 */
2057
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2058
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2059
		}
2060
	}
2061
2062
	/**
2063
	 * Check if Jetpack's Twitter tags should be used.
2064
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2065
	 *
2066
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2067
	 * @action plugins_loaded
2068
	 * @return null
2069
	 */
2070
	public function check_twitter_tags() {
2071
2072
		$active_plugins = self::get_active_plugins();
2073
2074
		if ( ! empty( $active_plugins ) ) {
2075
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2076
				if ( in_array( $plugin, $active_plugins ) ) {
2077
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2078
					break;
2079
				}
2080
			}
2081
		}
2082
2083
		/**
2084
		 * Allow Twitter Card Meta tags to be disabled.
2085
		 *
2086
		 * @since 2.6.0
2087
		 *
2088
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2089
		 */
2090
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2091
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2092
		}
2093
	}
2094
2095
	/**
2096
	 * Allows plugins to submit security reports.
2097
	 *
2098
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2099
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2100
	 * @param array  $args         See definitions above
2101
	 */
2102
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2103
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2104
	}
2105
2106
	/* Jetpack Options API */
2107
2108
	public static function get_option_names( $type = 'compact' ) {
2109
		return Jetpack_Options::get_option_names( $type );
2110
	}
2111
2112
	/**
2113
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2114
	 *
2115
	 * @param string $name    Option name
2116
	 * @param mixed  $default (optional)
2117
	 */
2118
	public static function get_option( $name, $default = false ) {
2119
		return Jetpack_Options::get_option( $name, $default );
2120
	}
2121
2122
	/**
2123
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2124
	 *
2125
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2126
	 * @param string $name  Option name
2127
	 * @param mixed  $value Option value
2128
	 */
2129
	public static function update_option( $name, $value ) {
2130
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2131
		return Jetpack_Options::update_option( $name, $value );
2132
	}
2133
2134
	/**
2135
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2136
	 *
2137
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2138
	 * @param array $array array( option name => option value, ... )
2139
	 */
2140
	public static function update_options( $array ) {
2141
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2142
		return Jetpack_Options::update_options( $array );
2143
	}
2144
2145
	/**
2146
	 * Deletes the given option.  May be passed multiple option names as an array.
2147
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2148
	 *
2149
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2150
	 * @param string|array $names
2151
	 */
2152
	public static function delete_option( $names ) {
2153
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2154
		return Jetpack_Options::delete_option( $names );
2155
	}
2156
2157
	/**
2158
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2159
	 *
2160
	 * Enters a user token into the user_tokens option
2161
	 *
2162
	 * @param int    $user_id The user id.
2163
	 * @param string $token The user token.
2164
	 * @param bool   $is_master_user Whether the user is the master user.
2165
	 * @return bool
2166
	 */
2167
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2168
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2169
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2170
	}
2171
2172
	/**
2173
	 * Returns an array of all PHP files in the specified absolute path.
2174
	 * Equivalent to glob( "$absolute_path/*.php" ).
2175
	 *
2176
	 * @param string $absolute_path The absolute path of the directory to search.
2177
	 * @return array Array of absolute paths to the PHP files.
2178
	 */
2179
	public static function glob_php( $absolute_path ) {
2180
		if ( function_exists( 'glob' ) ) {
2181
			return glob( "$absolute_path/*.php" );
2182
		}
2183
2184
		$absolute_path = untrailingslashit( $absolute_path );
2185
		$files         = array();
2186
		if ( ! $dir = @opendir( $absolute_path ) ) {
2187
			return $files;
2188
		}
2189
2190
		while ( false !== $file = readdir( $dir ) ) {
2191
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2192
				continue;
2193
			}
2194
2195
			$file = "$absolute_path/$file";
2196
2197
			if ( ! is_file( $file ) ) {
2198
				continue;
2199
			}
2200
2201
			$files[] = $file;
2202
		}
2203
2204
		closedir( $dir );
2205
2206
		return $files;
2207
	}
2208
2209
	public static function activate_new_modules( $redirect = false ) {
2210
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2211
			return;
2212
		}
2213
2214
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2215 View Code Duplication
		if ( ! $jetpack_old_version ) {
2216
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2217
			/** This action is documented in class.jetpack.php */
2218
			do_action( 'updating_jetpack_version', $version, false );
2219
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2220
		}
2221
2222
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2223
2224
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2225
			return;
2226
		}
2227
2228
		$active_modules     = self::get_active_modules();
2229
		$reactivate_modules = array();
2230
		foreach ( $active_modules as $active_module ) {
2231
			$module = self::get_module( $active_module );
2232
			if ( ! isset( $module['changed'] ) ) {
2233
				continue;
2234
			}
2235
2236
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2237
				continue;
2238
			}
2239
2240
			$reactivate_modules[] = $active_module;
2241
			self::deactivate_module( $active_module );
2242
		}
2243
2244
		$new_version = JETPACK__VERSION . ':' . time();
2245
		/** This action is documented in class.jetpack.php */
2246
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2247
		Jetpack_Options::update_options(
2248
			array(
2249
				'version'     => $new_version,
2250
				'old_version' => $jetpack_old_version,
2251
			)
2252
		);
2253
2254
		self::state( 'message', 'modules_activated' );
2255
		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...
2256
2257
		if ( $redirect ) {
2258
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2259
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2260
				$page = $_GET['page'];
2261
			}
2262
2263
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2264
			exit;
2265
		}
2266
	}
2267
2268
	/**
2269
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2270
	 * Make sure to tuck away module "library" files in a sub-directory.
2271
	 */
2272
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2273
		static $modules = null;
2274
2275
		if ( ! isset( $modules ) ) {
2276
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2277
			// Use the cache if we're on the front-end and it's available...
2278
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2279
				$modules = $available_modules_option[ JETPACK__VERSION ];
2280
			} else {
2281
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2282
2283
				$modules = array();
2284
2285
				foreach ( $files as $file ) {
2286
					if ( ! $headers = self::get_module( $file ) ) {
2287
						continue;
2288
					}
2289
2290
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2291
				}
2292
2293
				Jetpack_Options::update_option(
2294
					'available_modules',
2295
					array(
2296
						JETPACK__VERSION => $modules,
2297
					)
2298
				);
2299
			}
2300
		}
2301
2302
		/**
2303
		 * Filters the array of modules available to be activated.
2304
		 *
2305
		 * @since 2.4.0
2306
		 *
2307
		 * @param array $modules Array of available modules.
2308
		 * @param string $min_version Minimum version number required to use modules.
2309
		 * @param string $max_version Maximum version number required to use modules.
2310
		 */
2311
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2312
2313
		if ( ! $min_version && ! $max_version ) {
2314
			return array_keys( $mods );
2315
		}
2316
2317
		$r = array();
2318
		foreach ( $mods as $slug => $introduced ) {
2319
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2320
				continue;
2321
			}
2322
2323
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2324
				continue;
2325
			}
2326
2327
			$r[] = $slug;
2328
		}
2329
2330
		return $r;
2331
	}
2332
2333
	/**
2334
	 * Default modules loaded on activation.
2335
	 */
2336
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2337
		$return = array();
2338
2339
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2340
			$module_data = self::get_module( $module );
2341
2342
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2343
				case 'yes':
2344
					$return[] = $module;
2345
					break;
2346
				case 'public':
2347
					if ( Jetpack_Options::get_option( 'public' ) ) {
2348
						$return[] = $module;
2349
					}
2350
					break;
2351
				case 'no':
2352
				default:
2353
					break;
2354
			}
2355
		}
2356
		/**
2357
		 * Filters the array of default modules.
2358
		 *
2359
		 * @since 2.5.0
2360
		 *
2361
		 * @param array $return Array of default modules.
2362
		 * @param string $min_version Minimum version number required to use modules.
2363
		 * @param string $max_version Maximum version number required to use modules.
2364
		 */
2365
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2366
	}
2367
2368
	/**
2369
	 * Checks activated modules during auto-activation to determine
2370
	 * if any of those modules are being deprecated.  If so, close
2371
	 * them out, and add any replacement modules.
2372
	 *
2373
	 * Runs at priority 99 by default.
2374
	 *
2375
	 * This is run late, so that it can still activate a module if
2376
	 * the new module is a replacement for another that the user
2377
	 * currently has active, even if something at the normal priority
2378
	 * would kibosh everything.
2379
	 *
2380
	 * @since 2.6
2381
	 * @uses jetpack_get_default_modules filter
2382
	 * @param array $modules
2383
	 * @return array
2384
	 */
2385
	function handle_deprecated_modules( $modules ) {
2386
		$deprecated_modules = array(
2387
			'debug'            => null,  // Closed out and moved to the debugger library.
2388
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2389
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2390
		);
2391
2392
		// Don't activate SSO if they never completed activating WPCC.
2393
		if ( self::is_module_active( 'wpcc' ) ) {
2394
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2395
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2396
				$deprecated_modules['wpcc'] = null;
2397
			}
2398
		}
2399
2400
		foreach ( $deprecated_modules as $module => $replacement ) {
2401
			if ( self::is_module_active( $module ) ) {
2402
				self::deactivate_module( $module );
2403
				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...
2404
					$modules[] = $replacement;
2405
				}
2406
			}
2407
		}
2408
2409
		return array_unique( $modules );
2410
	}
2411
2412
	/**
2413
	 * Checks activated plugins during auto-activation to determine
2414
	 * if any of those plugins are in the list with a corresponding module
2415
	 * that is not compatible with the plugin. The module will not be allowed
2416
	 * to auto-activate.
2417
	 *
2418
	 * @since 2.6
2419
	 * @uses jetpack_get_default_modules filter
2420
	 * @param array $modules
2421
	 * @return array
2422
	 */
2423
	function filter_default_modules( $modules ) {
2424
2425
		$active_plugins = self::get_active_plugins();
2426
2427
		if ( ! empty( $active_plugins ) ) {
2428
2429
			// For each module we'd like to auto-activate...
2430
			foreach ( $modules as $key => $module ) {
2431
				// If there are potential conflicts for it...
2432
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2433
					// For each potential conflict...
2434
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2435
						// If that conflicting plugin is active...
2436
						if ( in_array( $plugin, $active_plugins ) ) {
2437
							// Remove that item from being auto-activated.
2438
							unset( $modules[ $key ] );
2439
						}
2440
					}
2441
				}
2442
			}
2443
		}
2444
2445
		return $modules;
2446
	}
2447
2448
	/**
2449
	 * Extract a module's slug from its full path.
2450
	 */
2451
	public static function get_module_slug( $file ) {
2452
		return str_replace( '.php', '', basename( $file ) );
2453
	}
2454
2455
	/**
2456
	 * Generate a module's path from its slug.
2457
	 */
2458
	public static function get_module_path( $slug ) {
2459
		/**
2460
		 * Filters the path of a modules.
2461
		 *
2462
		 * @since 7.4.0
2463
		 *
2464
		 * @param array $return The absolute path to a module's root php file
2465
		 * @param string $slug The module slug
2466
		 */
2467
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2468
	}
2469
2470
	/**
2471
	 * Load module data from module file. Headers differ from WordPress
2472
	 * plugin headers to avoid them being identified as standalone
2473
	 * plugins on the WordPress plugins page.
2474
	 */
2475
	public static function get_module( $module ) {
2476
		$headers = array(
2477
			'name'                      => 'Module Name',
2478
			'description'               => 'Module Description',
2479
			'sort'                      => 'Sort Order',
2480
			'recommendation_order'      => 'Recommendation Order',
2481
			'introduced'                => 'First Introduced',
2482
			'changed'                   => 'Major Changes In',
2483
			'deactivate'                => 'Deactivate',
2484
			'free'                      => 'Free',
2485
			'requires_connection'       => 'Requires Connection',
2486
			'auto_activate'             => 'Auto Activate',
2487
			'module_tags'               => 'Module Tags',
2488
			'feature'                   => 'Feature',
2489
			'additional_search_queries' => 'Additional Search Queries',
2490
			'plan_classes'              => 'Plans',
2491
		);
2492
2493
		$file = self::get_module_path( self::get_module_slug( $module ) );
2494
2495
		$mod = self::get_file_data( $file, $headers );
2496
		if ( empty( $mod['name'] ) ) {
2497
			return false;
2498
		}
2499
2500
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2501
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2502
		$mod['deactivate']           = empty( $mod['deactivate'] );
2503
		$mod['free']                 = empty( $mod['free'] );
2504
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2505
2506
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2507
			$mod['auto_activate'] = 'No';
2508
		} else {
2509
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2510
		}
2511
2512
		if ( $mod['module_tags'] ) {
2513
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2514
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2515
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2516
		} else {
2517
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2518
		}
2519
2520 View Code Duplication
		if ( $mod['plan_classes'] ) {
2521
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2522
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2523
		} else {
2524
			$mod['plan_classes'] = array( 'free' );
2525
		}
2526
2527 View Code Duplication
		if ( $mod['feature'] ) {
2528
			$mod['feature'] = explode( ',', $mod['feature'] );
2529
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2530
		} else {
2531
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2532
		}
2533
2534
		/**
2535
		 * Filters the feature array on a module.
2536
		 *
2537
		 * This filter allows you to control where each module is filtered: Recommended,
2538
		 * and the default "Other" listing.
2539
		 *
2540
		 * @since 3.5.0
2541
		 *
2542
		 * @param array   $mod['feature'] The areas to feature this module:
2543
		 *     'Recommended' shows on the main Jetpack admin screen.
2544
		 *     'Other' should be the default if no other value is in the array.
2545
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2546
		 * @param array   $mod All the currently assembled module data.
2547
		 */
2548
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2549
2550
		/**
2551
		 * Filter the returned data about a module.
2552
		 *
2553
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2554
		 * so please be careful.
2555
		 *
2556
		 * @since 3.6.0
2557
		 *
2558
		 * @param array   $mod    The details of the requested module.
2559
		 * @param string  $module The slug of the module, e.g. sharedaddy
2560
		 * @param string  $file   The path to the module source file.
2561
		 */
2562
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2563
	}
2564
2565
	/**
2566
	 * Like core's get_file_data implementation, but caches the result.
2567
	 */
2568
	public static function get_file_data( $file, $headers ) {
2569
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2570
		$file_name = basename( $file );
2571
2572
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2573
2574
		$file_data_option = get_transient( $cache_key );
2575
2576
		if ( ! is_array( $file_data_option ) ) {
2577
			delete_transient( $cache_key );
2578
			$file_data_option = false;
2579
		}
2580
2581
		if ( false === $file_data_option ) {
2582
			$file_data_option = array();
2583
		}
2584
2585
		$key           = md5( $file_name . serialize( $headers ) );
2586
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2587
2588
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2589
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2590
			return $file_data_option[ $key ];
2591
		}
2592
2593
		$data = get_file_data( $file, $headers );
2594
2595
		$file_data_option[ $key ] = $data;
2596
2597
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2598
2599
		return $data;
2600
	}
2601
2602
2603
	/**
2604
	 * Return translated module tag.
2605
	 *
2606
	 * @param string $tag Tag as it appears in each module heading.
2607
	 *
2608
	 * @return mixed
2609
	 */
2610
	public static function translate_module_tag( $tag ) {
2611
		return jetpack_get_module_i18n_tag( $tag );
2612
	}
2613
2614
	/**
2615
	 * Get i18n strings as a JSON-encoded string
2616
	 *
2617
	 * @return string The locale as JSON
2618
	 */
2619
	public static function get_i18n_data_json() {
2620
2621
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2622
		// JSON files with the file they should be included for. This is an md5
2623
		// of '_inc/build/admin.js'.
2624
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2625
2626
		$i18n_json =
2627
				   JETPACK__PLUGIN_DIR
2628
				   . 'languages/json/jetpack-'
2629
				   . get_user_locale()
2630
				   . '-'
2631
				   . $path_md5
2632
				   . '.json';
2633
2634
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2635
			$locale_data = @file_get_contents( $i18n_json );
2636
			if ( $locale_data ) {
2637
				return $locale_data;
2638
			}
2639
		}
2640
2641
		// Return valid empty Jed locale
2642
		return '{ "locale_data": { "messages": { "": {} } } }';
2643
	}
2644
2645
	/**
2646
	 * Add locale data setup to wp-i18n
2647
	 *
2648
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2649
	 *
2650
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2651
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2652
	 *
2653
	 * This method provides a safe way to request the setup multiple times but add the script at
2654
	 * most once.
2655
	 *
2656
	 * @since 6.7.0
2657
	 *
2658
	 * @return void
2659
	 */
2660
	public static function setup_wp_i18n_locale_data() {
2661
		static $script_added = false;
2662
		if ( ! $script_added ) {
2663
			$script_added = true;
2664
			wp_add_inline_script(
2665
				'wp-i18n',
2666
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2667
			);
2668
		}
2669
	}
2670
2671
	/**
2672
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2673
	 *
2674
	 * @since 3.9.2
2675
	 *
2676
	 * @param array $modules
2677
	 *
2678
	 * @return string|void
2679
	 */
2680
	public static function get_translated_modules( $modules ) {
2681
		foreach ( $modules as $index => $module ) {
2682
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2683
			if ( isset( $module['name'] ) ) {
2684
				$modules[ $index ]['name'] = $i18n_module['name'];
2685
			}
2686
			if ( isset( $module['description'] ) ) {
2687
				$modules[ $index ]['description']       = $i18n_module['description'];
2688
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2689
			}
2690
		}
2691
		return $modules;
2692
	}
2693
2694
	/**
2695
	 * Get a list of activated modules as an array of module slugs.
2696
	 */
2697
	public static function get_active_modules() {
2698
		$active = Jetpack_Options::get_option( 'active_modules' );
2699
2700
		if ( ! is_array( $active ) ) {
2701
			$active = array();
2702
		}
2703
2704
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2705
			$active[] = 'vaultpress';
2706
		} else {
2707
			$active = array_diff( $active, array( 'vaultpress' ) );
2708
		}
2709
2710
		// If protect is active on the main site of a multisite, it should be active on all sites.
2711
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2712
			$active[] = 'protect';
2713
		}
2714
2715
		/**
2716
		 * Allow filtering of the active modules.
2717
		 *
2718
		 * Gives theme and plugin developers the power to alter the modules that
2719
		 * are activated on the fly.
2720
		 *
2721
		 * @since 5.8.0
2722
		 *
2723
		 * @param array $active Array of active module slugs.
2724
		 */
2725
		$active = apply_filters( 'jetpack_active_modules', $active );
2726
2727
		return array_unique( $active );
2728
	}
2729
2730
	/**
2731
	 * Check whether or not a Jetpack module is active.
2732
	 *
2733
	 * @param string $module The slug of a Jetpack module.
2734
	 * @return bool
2735
	 *
2736
	 * @static
2737
	 */
2738
	public static function is_module_active( $module ) {
2739
		return in_array( $module, self::get_active_modules() );
2740
	}
2741
2742
	public static function is_module( $module ) {
2743
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2744
	}
2745
2746
	/**
2747
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2748
	 *
2749
	 * @param bool $catch True to start catching, False to stop.
2750
	 *
2751
	 * @static
2752
	 */
2753
	public static function catch_errors( $catch ) {
2754
		static $display_errors, $error_reporting;
2755
2756
		if ( $catch ) {
2757
			$display_errors  = @ini_set( 'display_errors', 1 );
2758
			$error_reporting = @error_reporting( E_ALL );
2759
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2760
		} else {
2761
			@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...
2762
			@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...
2763
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2764
		}
2765
	}
2766
2767
	/**
2768
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2769
	 */
2770
	public static function catch_errors_on_shutdown() {
2771
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2772
	}
2773
2774
	/**
2775
	 * Rewrite any string to make paths easier to read.
2776
	 *
2777
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2778
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2779
	 *
2780
	 * @param $string
2781
	 * @return mixed
2782
	 */
2783
	public static function alias_directories( $string ) {
2784
		// ABSPATH has a trailing slash.
2785
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2786
		// WP_CONTENT_DIR does not have a trailing slash.
2787
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2788
2789
		return $string;
2790
	}
2791
2792
	public static function activate_default_modules(
2793
		$min_version = false,
2794
		$max_version = false,
2795
		$other_modules = array(),
2796
		$redirect = null,
2797
		$send_state_messages = null
2798
	) {
2799
		$jetpack = self::init();
2800
2801
		if ( is_null( $redirect ) ) {
2802
			if (
2803
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2804
			||
2805
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2806
			||
2807
				( defined( 'WP_CLI' ) && WP_CLI )
2808
			||
2809
				( defined( 'DOING_CRON' ) && DOING_CRON )
2810
			||
2811
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2812
			) {
2813
				$redirect = false;
2814
			} elseif ( is_admin() ) {
2815
				$redirect = true;
2816
			} else {
2817
				$redirect = false;
2818
			}
2819
		}
2820
2821
		if ( is_null( $send_state_messages ) ) {
2822
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2823
		}
2824
2825
		$modules = self::get_default_modules( $min_version, $max_version );
2826
		$modules = array_merge( $other_modules, $modules );
2827
2828
		// Look for standalone plugins and disable if active.
2829
2830
		$to_deactivate = array();
2831
		foreach ( $modules as $module ) {
2832
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2833
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2834
			}
2835
		}
2836
2837
		$deactivated = array();
2838
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2839
			list( $probable_file, $probable_title ) = $deactivate_me;
2840
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2841
				$deactivated[] = $module;
2842
			}
2843
		}
2844
2845
		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...
2846
			if ( $send_state_messages ) {
2847
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2848
			}
2849
2850
			if ( $redirect ) {
2851
				$url = add_query_arg(
2852
					array(
2853
						'action'   => 'activate_default_modules',
2854
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2855
					),
2856
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2857
				);
2858
				wp_safe_redirect( $url );
2859
				exit;
2860
			}
2861
		}
2862
2863
		/**
2864
		 * Fires before default modules are activated.
2865
		 *
2866
		 * @since 1.9.0
2867
		 *
2868
		 * @param string $min_version Minimum version number required to use modules.
2869
		 * @param string $max_version Maximum version number required to use modules.
2870
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2871
		 */
2872
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2873
2874
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2875
		if ( $send_state_messages ) {
2876
			self::restate();
2877
			self::catch_errors( true );
2878
		}
2879
2880
		$active = self::get_active_modules();
2881
2882
		foreach ( $modules as $module ) {
2883
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2884
				$active[] = $module;
2885
				self::update_active_modules( $active );
2886
				continue;
2887
			}
2888
2889
			if ( $send_state_messages && in_array( $module, $active ) ) {
2890
				$module_info = self::get_module( $module );
2891 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2892
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2893
					if ( $active_state = self::state( $state ) ) {
2894
						$active_state = explode( ',', $active_state );
2895
					} else {
2896
						$active_state = array();
2897
					}
2898
					$active_state[] = $module;
2899
					self::state( $state, implode( ',', $active_state ) );
2900
				}
2901
				continue;
2902
			}
2903
2904
			$file = self::get_module_path( $module );
2905
			if ( ! file_exists( $file ) ) {
2906
				continue;
2907
			}
2908
2909
			// we'll override this later if the plugin can be included without fatal error
2910
			if ( $redirect ) {
2911
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2912
			}
2913
2914
			if ( $send_state_messages ) {
2915
				self::state( 'error', 'module_activation_failed' );
2916
				self::state( 'module', $module );
2917
			}
2918
2919
			ob_start();
2920
			require_once $file;
2921
2922
			$active[] = $module;
2923
2924 View Code Duplication
			if ( $send_state_messages ) {
2925
2926
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2927
				if ( $active_state = self::state( $state ) ) {
2928
					$active_state = explode( ',', $active_state );
2929
				} else {
2930
					$active_state = array();
2931
				}
2932
				$active_state[] = $module;
2933
				self::state( $state, implode( ',', $active_state ) );
2934
			}
2935
2936
			self::update_active_modules( $active );
2937
2938
			ob_end_clean();
2939
		}
2940
2941
		if ( $send_state_messages ) {
2942
			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...
2943
			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...
2944
		}
2945
2946
		self::catch_errors( false );
2947
		/**
2948
		 * Fires when default modules are activated.
2949
		 *
2950
		 * @since 1.9.0
2951
		 *
2952
		 * @param string $min_version Minimum version number required to use modules.
2953
		 * @param string $max_version Maximum version number required to use modules.
2954
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2955
		 */
2956
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2957
	}
2958
2959
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2960
		/**
2961
		 * Fires before a module is activated.
2962
		 *
2963
		 * @since 2.6.0
2964
		 *
2965
		 * @param string $module Module slug.
2966
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2967
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2968
		 */
2969
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2970
2971
		$jetpack = self::init();
2972
2973
		if ( ! strlen( $module ) ) {
2974
			return false;
2975
		}
2976
2977
		if ( ! self::is_module( $module ) ) {
2978
			return false;
2979
		}
2980
2981
		// If it's already active, then don't do it again
2982
		$active = self::get_active_modules();
2983
		foreach ( $active as $act ) {
2984
			if ( $act == $module ) {
2985
				return true;
2986
			}
2987
		}
2988
2989
		$module_data = self::get_module( $module );
2990
2991
		$is_development_mode = ( new Status() )->is_development_mode();
2992
		if ( ! self::is_active() ) {
2993
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
2994
				return false;
2995
			}
2996
2997
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2998
			if ( $is_development_mode && $module_data['requires_connection'] ) {
2999
				return false;
3000
			}
3001
		}
3002
3003
		// Check and see if the old plugin is active
3004
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3005
			// Deactivate the old plugin
3006
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3007
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3008
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3009
				self::state( 'deactivated_plugins', $module );
3010
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3011
				exit;
3012
			}
3013
		}
3014
3015
		// Protect won't work with mis-configured IPs
3016
		if ( 'protect' === $module ) {
3017
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3018
			if ( ! jetpack_protect_get_ip() ) {
3019
				self::state( 'message', 'protect_misconfigured_ip' );
3020
				return false;
3021
			}
3022
		}
3023
3024
		if ( ! Jetpack_Plan::supports( $module ) ) {
3025
			return false;
3026
		}
3027
3028
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3029
		self::state( 'module', $module );
3030
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3031
3032
		self::catch_errors( true );
3033
		ob_start();
3034
		require self::get_module_path( $module );
3035
		/** This action is documented in class.jetpack.php */
3036
		do_action( 'jetpack_activate_module', $module );
3037
		$active[] = $module;
3038
		self::update_active_modules( $active );
3039
3040
		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...
3041
		ob_end_clean();
3042
		self::catch_errors( false );
3043
3044
		if ( $redirect ) {
3045
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3046
		}
3047
		if ( $exit ) {
3048
			exit;
3049
		}
3050
		return true;
3051
	}
3052
3053
	function activate_module_actions( $module ) {
3054
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3055
	}
3056
3057
	public static function deactivate_module( $module ) {
3058
		/**
3059
		 * Fires when a module is deactivated.
3060
		 *
3061
		 * @since 1.9.0
3062
		 *
3063
		 * @param string $module Module slug.
3064
		 */
3065
		do_action( 'jetpack_pre_deactivate_module', $module );
3066
3067
		$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...
3068
3069
		$active = self::get_active_modules();
3070
		$new    = array_filter( array_diff( $active, (array) $module ) );
3071
3072
		return self::update_active_modules( $new );
3073
	}
3074
3075
	public static function enable_module_configurable( $module ) {
3076
		$module = self::get_module_slug( $module );
3077
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3078
	}
3079
3080
	/**
3081
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3082
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3083
	 *
3084
	 * @param string $module Module slug
3085
	 * @return string $url module configuration URL
3086
	 */
3087
	public static function module_configuration_url( $module ) {
3088
		$module      = self::get_module_slug( $module );
3089
		$default_url = self::admin_url() . "#/settings?term=$module";
3090
		/**
3091
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3092
		 *
3093
		 * @since 6.9.0
3094
		 *
3095
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3096
		 */
3097
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3098
3099
		return $url;
3100
	}
3101
3102
	/* Installation */
3103
	public static function bail_on_activation( $message, $deactivate = true ) {
3104
		?>
3105
<!doctype html>
3106
<html>
3107
<head>
3108
<meta charset="<?php bloginfo( 'charset' ); ?>">
3109
<style>
3110
* {
3111
	text-align: center;
3112
	margin: 0;
3113
	padding: 0;
3114
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3115
}
3116
p {
3117
	margin-top: 1em;
3118
	font-size: 18px;
3119
}
3120
</style>
3121
<body>
3122
<p><?php echo esc_html( $message ); ?></p>
3123
</body>
3124
</html>
3125
		<?php
3126
		if ( $deactivate ) {
3127
			$plugins = get_option( 'active_plugins' );
3128
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3129
			$update  = false;
3130
			foreach ( $plugins as $i => $plugin ) {
3131
				if ( $plugin === $jetpack ) {
3132
					$plugins[ $i ] = false;
3133
					$update        = true;
3134
				}
3135
			}
3136
3137
			if ( $update ) {
3138
				update_option( 'active_plugins', array_filter( $plugins ) );
3139
			}
3140
		}
3141
		exit;
3142
	}
3143
3144
	/**
3145
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3146
	 *
3147
	 * @static
3148
	 */
3149
	public static function plugin_activation( $network_wide ) {
3150
		Jetpack_Options::update_option( 'activated', 1 );
3151
3152
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3153
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3154
		}
3155
3156
		if ( $network_wide ) {
3157
			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...
3158
		}
3159
3160
		// For firing one-off events (notices) immediately after activation
3161
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3162
3163
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3164
3165
		self::plugin_initialize();
3166
	}
3167
3168
	public static function get_activation_source( $referer_url ) {
3169
3170
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3171
			return array( 'wp-cli', null );
3172
		}
3173
3174
		$referer = wp_parse_url( $referer_url );
3175
3176
		$source_type  = 'unknown';
3177
		$source_query = null;
3178
3179
		if ( ! is_array( $referer ) ) {
3180
			return array( $source_type, $source_query );
3181
		}
3182
3183
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3184
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3185
3186
		if ( isset( $referer['query'] ) ) {
3187
			parse_str( $referer['query'], $query_parts );
3188
		} else {
3189
			$query_parts = array();
3190
		}
3191
3192
		if ( $plugins_path === $referer['path'] ) {
3193
			$source_type = 'list';
3194
		} elseif ( $plugins_install_path === $referer['path'] ) {
3195
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3196
			switch ( $tab ) {
3197
				case 'popular':
3198
					$source_type = 'popular';
3199
					break;
3200
				case 'recommended':
3201
					$source_type = 'recommended';
3202
					break;
3203
				case 'favorites':
3204
					$source_type = 'favorites';
3205
					break;
3206
				case 'search':
3207
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3208
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3209
					break;
3210
				default:
3211
					$source_type = 'featured';
3212
			}
3213
		}
3214
3215
		return array( $source_type, $source_query );
3216
	}
3217
3218
	/**
3219
	 * Runs before bumping version numbers up to a new version
3220
	 *
3221
	 * @param  string $version    Version:timestamp
3222
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3223
	 * @return null              [description]
3224
	 */
3225
	public static function do_version_bump( $version, $old_version ) {
3226
		if ( ! $old_version ) { // For new sites
3227
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3228
		}
3229
	}
3230
3231
	/**
3232
	 * Sets the internal version number and activation state.
3233
	 *
3234
	 * @static
3235
	 */
3236
	public static function plugin_initialize() {
3237
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3238
			Jetpack_Options::update_option( 'activated', 2 );
3239
		}
3240
3241 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3242
			$version = $old_version = JETPACK__VERSION . ':' . time();
3243
			/** This action is documented in class.jetpack.php */
3244
			do_action( 'updating_jetpack_version', $version, false );
3245
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3246
		}
3247
3248
		self::load_modules();
3249
3250
		Jetpack_Options::delete_option( 'do_activate' );
3251
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3252
	}
3253
3254
	/**
3255
	 * Removes all connection options
3256
	 *
3257
	 * @static
3258
	 */
3259
	public static function plugin_deactivation() {
3260
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3261
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3262
			Jetpack_Network::init()->deactivate();
3263
		} else {
3264
			self::disconnect( false );
3265
			// Jetpack_Heartbeat::init()->deactivate();
3266
		}
3267
	}
3268
3269
	/**
3270
	 * Disconnects from the Jetpack servers.
3271
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3272
	 *
3273
	 * @static
3274
	 */
3275
	public static function disconnect( $update_activated_state = true ) {
3276
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3277
		$connection = self::connection();
3278
		$connection->clean_nonces( true );
3279
3280
		// If the site is in an IDC because sync is not allowed,
3281
		// let's make sure to not disconnect the production site.
3282
		if ( ! self::validate_sync_error_idc_option() ) {
3283
			$tracking = new Tracking();
3284
			$tracking->record_user_event( 'disconnect_site', array() );
3285
3286
			$connection->disconnect_site_wpcom();
3287
		}
3288
3289
		$connection->delete_all_connection_tokens();
3290
		Jetpack_IDC::clear_all_idc_options();
3291
3292
		if ( $update_activated_state ) {
3293
			Jetpack_Options::update_option( 'activated', 4 );
3294
		}
3295
3296
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3297
			// Check then record unique disconnection if site has never been disconnected previously
3298
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3299
				$jetpack_unique_connection['disconnected'] = 1;
3300
			} else {
3301
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3302
					// track unique disconnect
3303
					$jetpack = self::init();
3304
3305
					$jetpack->stat( 'connections', 'unique-disconnect' );
3306
					$jetpack->do_stats( 'server_side' );
3307
				}
3308
				// increment number of times disconnected
3309
				$jetpack_unique_connection['disconnected'] += 1;
3310
			}
3311
3312
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3313
		}
3314
3315
		// Delete all the sync related data. Since it could be taking up space.
3316
		Sender::get_instance()->uninstall();
3317
3318
		// Disable the Heartbeat cron
3319
		Jetpack_Heartbeat::init()->deactivate();
3320
	}
3321
3322
	/**
3323
	 * Unlinks the current user from the linked WordPress.com user.
3324
	 *
3325
	 * @deprecated since 7.7
3326
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3327
	 *
3328
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|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...
3329
	 * @return Boolean Whether the disconnection of the user was successful.
3330
	 */
3331
	public static function unlink_user( $user_id = null ) {
3332
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3333
		return Connection_Manager::disconnect_user( $user_id );
3334
	}
3335
3336
	/**
3337
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3338
	 */
3339
	public static function try_registration() {
3340
		$terms_of_service = new Terms_Of_Service();
3341
		// The user has agreed to the TOS at some point by now.
3342
		$terms_of_service->agree();
3343
3344
		// Let's get some testing in beta versions and such.
3345
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3346
			// Before attempting to connect, let's make sure that the domains are viable.
3347
			$domains_to_check = array_unique(
3348
				array(
3349
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3350
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3351
				)
3352
			);
3353
			foreach ( $domains_to_check as $domain ) {
3354
				$result = self::connection()->is_usable_domain( $domain );
3355
				if ( is_wp_error( $result ) ) {
3356
					return $result;
3357
				}
3358
			}
3359
		}
3360
3361
		$result = self::register();
3362
3363
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3364
		if ( ! $result || is_wp_error( $result ) ) {
3365
			return $result;
3366
		} else {
3367
			return true;
3368
		}
3369
	}
3370
3371
	/**
3372
	 * Tracking an internal event log. Try not to put too much chaff in here.
3373
	 *
3374
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3375
	 */
3376
	public static function log( $code, $data = null ) {
3377
		// only grab the latest 200 entries
3378
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3379
3380
		// Append our event to the log
3381
		$log_entry = array(
3382
			'time'    => time(),
3383
			'user_id' => get_current_user_id(),
3384
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3385
			'code'    => $code,
3386
		);
3387
		// Don't bother storing it unless we've got some.
3388
		if ( ! is_null( $data ) ) {
3389
			$log_entry['data'] = $data;
3390
		}
3391
		$log[] = $log_entry;
3392
3393
		// Try add_option first, to make sure it's not autoloaded.
3394
		// @todo: Add an add_option method to Jetpack_Options
3395
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3396
			Jetpack_Options::update_option( 'log', $log );
3397
		}
3398
3399
		/**
3400
		 * Fires when Jetpack logs an internal event.
3401
		 *
3402
		 * @since 3.0.0
3403
		 *
3404
		 * @param array $log_entry {
3405
		 *  Array of details about the log entry.
3406
		 *
3407
		 *  @param string time Time of the event.
3408
		 *  @param int user_id ID of the user who trigerred the event.
3409
		 *  @param int blog_id Jetpack Blog ID.
3410
		 *  @param string code Unique name for the event.
3411
		 *  @param string data Data about the event.
3412
		 * }
3413
		 */
3414
		do_action( 'jetpack_log_entry', $log_entry );
3415
	}
3416
3417
	/**
3418
	 * Get the internal event log.
3419
	 *
3420
	 * @param $event (string) - only return the specific log events
3421
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3422
	 *
3423
	 * @return array of log events || WP_Error for invalid params
3424
	 */
3425
	public static function get_log( $event = false, $num = false ) {
3426
		if ( $event && ! is_string( $event ) ) {
3427
			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...
3428
		}
3429
3430
		if ( $num && ! is_numeric( $num ) ) {
3431
			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...
3432
		}
3433
3434
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3435
3436
		// If nothing set - act as it did before, otherwise let's start customizing the output
3437
		if ( ! $num && ! $event ) {
3438
			return $entire_log;
3439
		} else {
3440
			$entire_log = array_reverse( $entire_log );
3441
		}
3442
3443
		$custom_log_output = array();
3444
3445
		if ( $event ) {
3446
			foreach ( $entire_log as $log_event ) {
3447
				if ( $event == $log_event['code'] ) {
3448
					$custom_log_output[] = $log_event;
3449
				}
3450
			}
3451
		} else {
3452
			$custom_log_output = $entire_log;
3453
		}
3454
3455
		if ( $num ) {
3456
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3457
		}
3458
3459
		return $custom_log_output;
3460
	}
3461
3462
	/**
3463
	 * Log modification of important settings.
3464
	 */
3465
	public static function log_settings_change( $option, $old_value, $value ) {
3466
		switch ( $option ) {
3467
			case 'jetpack_sync_non_public_post_stati':
3468
				self::log( $option, $value );
3469
				break;
3470
		}
3471
	}
3472
3473
	/**
3474
	 * Return stat data for WPCOM sync
3475
	 */
3476
	public static function get_stat_data( $encode = true, $extended = true ) {
3477
		$data = Jetpack_Heartbeat::generate_stats_array();
3478
3479
		if ( $extended ) {
3480
			$additional_data = self::get_additional_stat_data();
3481
			$data            = array_merge( $data, $additional_data );
3482
		}
3483
3484
		if ( $encode ) {
3485
			return json_encode( $data );
3486
		}
3487
3488
		return $data;
3489
	}
3490
3491
	/**
3492
	 * Get additional stat data to sync to WPCOM
3493
	 */
3494
	public static function get_additional_stat_data( $prefix = '' ) {
3495
		$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...
3496
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3497
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3498
		$return[ "{$prefix}site-count" ]    = 0;
3499
3500
		if ( function_exists( 'get_blog_count' ) ) {
3501
			$return[ "{$prefix}site-count" ] = get_blog_count();
3502
		}
3503
		return $return;
3504
	}
3505
3506
	private static function get_site_user_count() {
3507
		global $wpdb;
3508
3509
		if ( function_exists( 'wp_is_large_network' ) ) {
3510
			if ( wp_is_large_network( 'users' ) ) {
3511
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3512
			}
3513
		}
3514
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3515
			// It wasn't there, so regenerate the data and save the transient
3516
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3517
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3518
		}
3519
		return $user_count;
3520
	}
3521
3522
	/* Admin Pages */
3523
3524
	function admin_init() {
3525
		// If the plugin is not connected, display a connect message.
3526
		if (
3527
			// the plugin was auto-activated and needs its candy
3528
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3529
		||
3530
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3531
			! Jetpack_Options::get_option( 'activated' )
3532
		) {
3533
			self::plugin_initialize();
3534
		}
3535
3536
		$is_development_mode = ( new Status() )->is_development_mode();
3537
		if ( ! self::is_active() && ! $is_development_mode ) {
3538
			Jetpack_Connection_Banner::init();
3539
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3540
			// Upgrade: 1.1 -> 1.1.1
3541
			// Check and see if host can verify the Jetpack servers' SSL certificate
3542
			$args       = array();
3543
			$connection = self::connection();
3544
			Client::_wp_remote_request(
3545
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3546
				$args,
3547
				true
3548
			);
3549
		}
3550
3551
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3552
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3553
		}
3554
3555
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3556
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3557
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3558
3559
		if ( self::is_active() || $is_development_mode ) {
3560
			// Artificially throw errors in certain whitelisted cases during plugin activation
3561
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3562
		}
3563
3564
		// Add custom column in wp-admin/users.php to show whether user is linked.
3565
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3566
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3567
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3568
	}
3569
3570
	function admin_body_class( $admin_body_class = '' ) {
3571
		$classes = explode( ' ', trim( $admin_body_class ) );
3572
3573
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3574
3575
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3576
		return " $admin_body_class ";
3577
	}
3578
3579
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3580
		return $admin_body_class . ' jetpack-pagestyles ';
3581
	}
3582
3583
	/**
3584
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3585
	 * This function artificially throws errors for such cases (whitelisted).
3586
	 *
3587
	 * @param string $plugin The activated plugin.
3588
	 */
3589
	function throw_error_on_activate_plugin( $plugin ) {
3590
		$active_modules = self::get_active_modules();
3591
3592
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3593
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3594
			$throw = false;
3595
3596
			// Try and make sure it really was the stats plugin
3597
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3598
				if ( 'stats.php' == basename( $plugin ) ) {
3599
					$throw = true;
3600
				}
3601
			} else {
3602
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3603
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3604
					$throw = true;
3605
				}
3606
			}
3607
3608
			if ( $throw ) {
3609
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3610
			}
3611
		}
3612
	}
3613
3614
	function intercept_plugin_error_scrape_init() {
3615
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3616
	}
3617
3618
	function intercept_plugin_error_scrape( $action, $result ) {
3619
		if ( ! $result ) {
3620
			return;
3621
		}
3622
3623
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3624
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3625
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3626
			}
3627
		}
3628
	}
3629
3630
	/**
3631
	 * Register the remote file upload request handlers, if needed.
3632
	 *
3633
	 * @access public
3634
	 */
3635
	public function add_remote_request_handlers() {
3636
		// Remote file uploads are allowed only via AJAX requests.
3637
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3638
			return;
3639
		}
3640
3641
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3642
		$remote_request_actions = array(
3643
			'jetpack_upload_file',
3644
			'jetpack_update_file',
3645
		);
3646
3647
		// phpcs:ignore WordPress.Security.NonceVerification
3648
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3649
			return;
3650
		}
3651
3652
		// Require Jetpack authentication for the remote file upload AJAX requests.
3653
		$this->connection_manager->require_jetpack_authentication();
3654
3655
		// Register the remote file upload AJAX handlers.
3656
		foreach ( $remote_request_actions as $action ) {
3657
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3658
		}
3659
	}
3660
3661
	/**
3662
	 * Handler for Jetpack remote file uploads.
3663
	 *
3664
	 * @access public
3665
	 */
3666
	public function remote_request_handlers() {
3667
		$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...
3668
3669
		switch ( current_filter() ) {
3670
			case 'wp_ajax_nopriv_jetpack_upload_file':
3671
				$response = $this->upload_handler();
3672
				break;
3673
3674
			case 'wp_ajax_nopriv_jetpack_update_file':
3675
				$response = $this->upload_handler( true );
3676
				break;
3677
			default:
3678
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_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...
3679
				break;
3680
		}
3681
3682
		if ( ! $response ) {
3683
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_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...
3684
		}
3685
3686
		if ( is_wp_error( $response ) ) {
3687
			$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<Jetpack_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...
3688
			$error             = $response->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<Jetpack_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...
3689
			$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<Jetpack_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...
3690
3691
			if ( ! is_int( $status_code ) ) {
3692
				$status_code = 400;
3693
			}
3694
3695
			status_header( $status_code );
3696
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3697
		}
3698
3699
		status_header( 200 );
3700
		if ( true === $response ) {
3701
			exit;
3702
		}
3703
3704
		die( json_encode( (object) $response ) );
3705
	}
3706
3707
	/**
3708
	 * Uploads a file gotten from the global $_FILES.
3709
	 * If `$update_media_item` is true and `post_id` is defined
3710
	 * the attachment file of the media item (gotten through of the post_id)
3711
	 * will be updated instead of add a new one.
3712
	 *
3713
	 * @param  boolean $update_media_item - update media attachment
3714
	 * @return array - An array describing the uploadind files process
3715
	 */
3716
	function upload_handler( $update_media_item = false ) {
3717
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3718
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_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...
3719
		}
3720
3721
		$user = wp_authenticate( '', '' );
3722
		if ( ! $user || is_wp_error( $user ) ) {
3723
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_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...
3724
		}
3725
3726
		wp_set_current_user( $user->ID );
3727
3728
		if ( ! current_user_can( 'upload_files' ) ) {
3729
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_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...
3730
		}
3731
3732
		if ( empty( $_FILES ) ) {
3733
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_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...
3734
		}
3735
3736
		foreach ( array_keys( $_FILES ) as $files_key ) {
3737
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3738
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_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...
3739
			}
3740
		}
3741
3742
		$media_keys = array_keys( $_FILES['media'] );
3743
3744
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

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...
3745
		if ( ! $token || is_wp_error( $token ) ) {
3746
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_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...
3747
		}
3748
3749
		$uploaded_files = array();
3750
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3751
		unset( $GLOBALS['post'] );
3752
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3753
			$file = array();
3754
			foreach ( $media_keys as $media_key ) {
3755
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3756
			}
3757
3758
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3759
3760
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3761
			if ( $hmac_provided !== $hmac_file ) {
3762
				$uploaded_files[ $index ] = (object) array(
3763
					'error'             => 'invalid_hmac',
3764
					'error_description' => 'The corresponding HMAC for this file does not match',
3765
				);
3766
				continue;
3767
			}
3768
3769
			$_FILES['.jetpack.upload.'] = $file;
3770
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3771
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3772
				$post_id = 0;
3773
			}
3774
3775
			if ( $update_media_item ) {
3776
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3777
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_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...
3778
				}
3779
3780
				$media_array = $_FILES['media'];
3781
3782
				$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...
3783
				$file_array['type']     = $media_array['type'][0];
3784
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3785
				$file_array['error']    = $media_array['error'][0];
3786
				$file_array['size']     = $media_array['size'][0];
3787
3788
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3789
3790
				if ( is_wp_error( $edited_media_item ) ) {
3791
					return $edited_media_item;
3792
				}
3793
3794
				$response = (object) array(
3795
					'id'   => (string) $post_id,
3796
					'file' => (string) $edited_media_item->post_title,
3797
					'url'  => (string) wp_get_attachment_url( $post_id ),
3798
					'type' => (string) $edited_media_item->post_mime_type,
3799
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3800
				);
3801
3802
				return (array) array( $response );
3803
			}
3804
3805
			$attachment_id = media_handle_upload(
3806
				'.jetpack.upload.',
3807
				$post_id,
3808
				array(),
3809
				array(
3810
					'action' => 'jetpack_upload_file',
3811
				)
3812
			);
3813
3814
			if ( ! $attachment_id ) {
3815
				$uploaded_files[ $index ] = (object) array(
3816
					'error'             => 'unknown',
3817
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3818
				);
3819
			} elseif ( is_wp_error( $attachment_id ) ) {
3820
				$uploaded_files[ $index ] = (object) array(
3821
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3822
					'error_description' => $attachment_id->get_error_message(),
3823
				);
3824
			} else {
3825
				$attachment               = get_post( $attachment_id );
3826
				$uploaded_files[ $index ] = (object) array(
3827
					'id'   => (string) $attachment_id,
3828
					'file' => $attachment->post_title,
3829
					'url'  => wp_get_attachment_url( $attachment_id ),
3830
					'type' => $attachment->post_mime_type,
3831
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3832
				);
3833
				// Zip files uploads are not supported unless they are done for installation purposed
3834
				// lets delete them in case something goes wrong in this whole process
3835
				if ( 'application/zip' === $attachment->post_mime_type ) {
3836
					// Schedule a cleanup for 2 hours from now in case of failed install.
3837
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3838
				}
3839
			}
3840
		}
3841
		if ( ! is_null( $global_post ) ) {
3842
			$GLOBALS['post'] = $global_post;
3843
		}
3844
3845
		return $uploaded_files;
3846
	}
3847
3848
	/**
3849
	 * Add help to the Jetpack page
3850
	 *
3851
	 * @since Jetpack (1.2.3)
3852
	 * @return false if not the Jetpack page
3853
	 */
3854
	function admin_help() {
3855
		$current_screen = get_current_screen();
3856
3857
		// Overview
3858
		$current_screen->add_help_tab(
3859
			array(
3860
				'id'      => 'home',
3861
				'title'   => __( 'Home', 'jetpack' ),
3862
				'content' =>
3863
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3864
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3865
					'<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>',
3866
			)
3867
		);
3868
3869
		// Screen Content
3870
		if ( current_user_can( 'manage_options' ) ) {
3871
			$current_screen->add_help_tab(
3872
				array(
3873
					'id'      => 'settings',
3874
					'title'   => __( 'Settings', 'jetpack' ),
3875
					'content' =>
3876
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3877
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3878
						'<ol>' .
3879
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3880
							'<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>' .
3881
						'</ol>' .
3882
						'<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>',
3883
				)
3884
			);
3885
		}
3886
3887
		// Help Sidebar
3888
		$current_screen->set_help_sidebar(
3889
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3890
			'<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3891
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3892
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3893
		);
3894
	}
3895
3896
	function admin_menu_css() {
3897
		wp_enqueue_style( 'jetpack-icons' );
3898
	}
3899
3900
	function admin_menu_order() {
3901
		return true;
3902
	}
3903
3904 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3905
		$jp_menu_order = array();
3906
3907
		foreach ( $menu_order as $index => $item ) {
3908
			if ( $item != 'jetpack' ) {
3909
				$jp_menu_order[] = $item;
3910
			}
3911
3912
			if ( $index == 0 ) {
3913
				$jp_menu_order[] = 'jetpack';
3914
			}
3915
		}
3916
3917
		return $jp_menu_order;
3918
	}
3919
3920
	function admin_banner_styles() {
3921
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3922
3923 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3924
			wp_register_style(
3925
				'jetpack-dops-style',
3926
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3927
				array(),
3928
				JETPACK__VERSION
3929
			);
3930
		}
3931
3932
		wp_enqueue_style(
3933
			'jetpack',
3934
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3935
			array( 'jetpack-dops-style' ),
3936
			JETPACK__VERSION . '-20121016'
3937
		);
3938
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3939
		wp_style_add_data( 'jetpack', 'suffix', $min );
3940
	}
3941
3942
	function plugin_action_links( $actions ) {
3943
3944
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3945
3946
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
3947
			return array_merge(
3948
				$jetpack_home,
3949
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3950
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3951
				$actions
3952
			);
3953
		}
3954
3955
		return array_merge( $jetpack_home, $actions );
3956
	}
3957
3958
	/*
3959
	 * Registration flow:
3960
	 * 1 - ::admin_page_load() action=register
3961
	 * 2 - ::try_registration()
3962
	 * 3 - ::register()
3963
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3964
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3965
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3966
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3967
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3968
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3969
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3970
	 *       jetpack_id, jetpack_secret, jetpack_public
3971
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3972
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3973
	 * 5 - user logs in with WP.com account
3974
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3975
	 *		- Manager::authorize()
3976
	 *		- Manager::get_token()
3977
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3978
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3979
	 *			- which responds with access_token, token_type, scope
3980
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
3981
	 *		- Jetpack::activate_default_modules()
3982
	 *     		- Deactivates deprecated plugins
3983
	 *     		- Activates all default modules
3984
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3985
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3986
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3987
	 *     Done!
3988
	 */
3989
3990
	/**
3991
	 * Handles the page load events for the Jetpack admin page
3992
	 */
3993
	function admin_page_load() {
3994
		$error = false;
3995
3996
		// Make sure we have the right body class to hook stylings for subpages off of.
3997
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
3998
3999
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4000
			// Should only be used in intermediate redirects to preserve state across redirects
4001
			self::restate();
4002
		}
4003
4004
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4005
			// @todo: Add validation against a known whitelist
4006
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4007
			// User clicked in the iframe to link their accounts
4008
			if ( ! self::is_user_connected() ) {
4009
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4010
4011
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4012
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4013
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4014
4015
				if ( isset( $_GET['notes_iframe'] ) ) {
4016
					$connect_url .= '&notes_iframe';
4017
				}
4018
				wp_redirect( $connect_url );
4019
				exit;
4020
			} else {
4021
				if ( ! isset( $_GET['calypso_env'] ) ) {
4022
					self::state( 'message', 'already_authorized' );
4023
					wp_safe_redirect( self::admin_url() );
4024
					exit;
4025
				} else {
4026
					$connect_url  = $this->build_connect_url( true, false, $from );
4027
					$connect_url .= '&already_authorized=true';
4028
					wp_redirect( $connect_url );
4029
					exit;
4030
				}
4031
			}
4032
		}
4033
4034
		if ( isset( $_GET['action'] ) ) {
4035
			switch ( $_GET['action'] ) {
4036
				case 'authorize':
4037
					if ( self::is_active() && self::is_user_connected() ) {
4038
						self::state( 'message', 'already_authorized' );
4039
						wp_safe_redirect( self::admin_url() );
4040
						exit;
4041
					}
4042
					self::log( 'authorize' );
4043
					$client_server = new Jetpack_Client_Server();
4044
					$client_server->client_authorize();
4045
					exit;
4046
				case 'register':
4047
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4048
						$error = 'cheatin';
4049
						break;
4050
					}
4051
					check_admin_referer( 'jetpack-register' );
4052
					self::log( 'register' );
4053
					self::maybe_set_version_option();
4054
					$registered = self::try_registration();
4055 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4056
						$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...
4057
						self::state( 'error', $error );
4058
						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...
4059
4060
						/**
4061
						 * Jetpack registration Error.
4062
						 *
4063
						 * @since 7.5.0
4064
						 *
4065
						 * @param string|int $error The error code.
4066
						 * @param \WP_Error $registered The error object.
4067
						 */
4068
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4069
						break;
4070
					}
4071
4072
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4073
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4074
4075
					/**
4076
					 * Jetpack registration Success.
4077
					 *
4078
					 * @since 7.5.0
4079
					 *
4080
					 * @param string $from 'from' GET parameter;
4081
					 */
4082
					do_action( 'jetpack_connection_register_success', $from );
4083
4084
					$url = $this->build_connect_url( true, $redirect, $from );
4085
4086
					if ( ! empty( $_GET['onboarding'] ) ) {
4087
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4088
					}
4089
4090
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4091
						$url = add_query_arg( 'auth_approved', 'true', $url );
4092
					}
4093
4094
					wp_redirect( $url );
4095
					exit;
4096
				case 'activate':
4097
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4098
						$error = 'cheatin';
4099
						break;
4100
					}
4101
4102
					$module = stripslashes( $_GET['module'] );
4103
					check_admin_referer( "jetpack_activate-$module" );
4104
					self::log( 'activate', $module );
4105
					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...
4106
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4107
					}
4108
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4109
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4110
					exit;
4111
				case 'activate_default_modules':
4112
					check_admin_referer( 'activate_default_modules' );
4113
					self::log( 'activate_default_modules' );
4114
					self::restate();
4115
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4116
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4117
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4118
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4119
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4120
					exit;
4121
				case 'disconnect':
4122
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4123
						$error = 'cheatin';
4124
						break;
4125
					}
4126
4127
					check_admin_referer( 'jetpack-disconnect' );
4128
					self::log( 'disconnect' );
4129
					self::disconnect();
4130
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4131
					exit;
4132
				case 'reconnect':
4133
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4134
						$error = 'cheatin';
4135
						break;
4136
					}
4137
4138
					check_admin_referer( 'jetpack-reconnect' );
4139
					self::log( 'reconnect' );
4140
					$this->disconnect();
4141
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4142
					exit;
4143 View Code Duplication
				case 'deactivate':
4144
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4145
						$error = 'cheatin';
4146
						break;
4147
					}
4148
4149
					$modules = stripslashes( $_GET['module'] );
4150
					check_admin_referer( "jetpack_deactivate-$modules" );
4151
					foreach ( explode( ',', $modules ) as $module ) {
4152
						self::log( 'deactivate', $module );
4153
						self::deactivate_module( $module );
4154
						self::state( 'message', 'module_deactivated' );
4155
					}
4156
					self::state( 'module', $modules );
4157
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4158
					exit;
4159
				case 'unlink':
4160
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4161
					check_admin_referer( 'jetpack-unlink' );
4162
					self::log( 'unlink' );
4163
					Connection_Manager::disconnect_user();
4164
					self::state( 'message', 'unlinked' );
4165
					if ( 'sub-unlink' == $redirect ) {
4166
						wp_safe_redirect( admin_url() );
4167
					} else {
4168
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4169
					}
4170
					exit;
4171
				case 'onboard':
4172
					if ( ! current_user_can( 'manage_options' ) ) {
4173
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4174
					} else {
4175
						self::create_onboarding_token();
4176
						$url = $this->build_connect_url( true );
4177
4178
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4179
							$url = add_query_arg( 'onboarding', $token, $url );
4180
						}
4181
4182
						$calypso_env = $this->get_calypso_env();
4183
						if ( ! empty( $calypso_env ) ) {
4184
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4185
						}
4186
4187
						wp_redirect( $url );
4188
						exit;
4189
					}
4190
					exit;
4191
				default:
4192
					/**
4193
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4194
					 *
4195
					 * @since 2.6.0
4196
					 *
4197
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4198
					 */
4199
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4200
			}
4201
		}
4202
4203
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4204
			self::activate_new_modules( true );
4205
		}
4206
4207
		$message_code = self::state( 'message' );
4208
		if ( self::state( 'optin-manage' ) ) {
4209
			$activated_manage = $message_code;
4210
			$message_code     = 'jetpack-manage';
4211
		}
4212
4213
		switch ( $message_code ) {
4214
			case 'jetpack-manage':
4215
				$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' ), 'https://wordpress.com/sites' ) . '</strong>';
4216
				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...
4217
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4218
				}
4219
				break;
4220
4221
		}
4222
4223
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4224
4225
		if ( ! empty( $deactivated_plugins ) ) {
4226
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4227
			$deactivated_titles  = array();
4228
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4229
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4230
					continue;
4231
				}
4232
4233
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4234
			}
4235
4236
			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...
4237
				if ( $this->message ) {
4238
					$this->message .= "<br /><br />\n";
4239
				}
4240
4241
				$this->message .= wp_sprintf(
4242
					_n(
4243
						'Jetpack contains the most recent version of the old %l plugin.',
4244
						'Jetpack contains the most recent versions of the old %l plugins.',
4245
						count( $deactivated_titles ),
4246
						'jetpack'
4247
					),
4248
					$deactivated_titles
4249
				);
4250
4251
				$this->message .= "<br />\n";
4252
4253
				$this->message .= _n(
4254
					'The old version has been deactivated and can be removed from your site.',
4255
					'The old versions have been deactivated and can be removed from your site.',
4256
					count( $deactivated_titles ),
4257
					'jetpack'
4258
				);
4259
			}
4260
		}
4261
4262
		$this->privacy_checks = self::state( 'privacy_checks' );
4263
4264
		if ( $this->message || $this->error || $this->privacy_checks ) {
4265
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4266
		}
4267
4268
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4269
	}
4270
4271
	function admin_notices() {
4272
4273
		if ( $this->error ) {
4274
			?>
4275
<div id="message" class="jetpack-message jetpack-err">
4276
	<div class="squeezer">
4277
		<h2>
4278
			<?php
4279
			echo wp_kses(
4280
				$this->error,
4281
				array(
4282
					'a'      => array( 'href' => array() ),
4283
					'small'  => true,
4284
					'code'   => true,
4285
					'strong' => true,
4286
					'br'     => true,
4287
					'b'      => true,
4288
				)
4289
			);
4290
			?>
4291
			</h2>
4292
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4293
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4294
<?php	endif; ?>
4295
	</div>
4296
</div>
4297
			<?php
4298
		}
4299
4300
		if ( $this->message ) {
4301
			?>
4302
<div id="message" class="jetpack-message">
4303
	<div class="squeezer">
4304
		<h2>
4305
			<?php
4306
			echo wp_kses(
4307
				$this->message,
4308
				array(
4309
					'strong' => array(),
4310
					'a'      => array( 'href' => true ),
4311
					'br'     => true,
4312
				)
4313
			);
4314
			?>
4315
			</h2>
4316
	</div>
4317
</div>
4318
			<?php
4319
		}
4320
4321
		if ( $this->privacy_checks ) :
4322
			$module_names = $module_slugs = array();
4323
4324
			$privacy_checks = explode( ',', $this->privacy_checks );
4325
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4326
			foreach ( $privacy_checks as $module_slug ) {
4327
				$module = self::get_module( $module_slug );
4328
				if ( ! $module ) {
4329
					continue;
4330
				}
4331
4332
				$module_slugs[] = $module_slug;
4333
				$module_names[] = "<strong>{$module['name']}</strong>";
4334
			}
4335
4336
			$module_slugs = join( ',', $module_slugs );
4337
			?>
4338
<div id="message" class="jetpack-message jetpack-err">
4339
	<div class="squeezer">
4340
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4341
		<p>
4342
			<?php
4343
			echo wp_kses(
4344
				wptexturize(
4345
					wp_sprintf(
4346
						_nx(
4347
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4348
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4349
							count( $privacy_checks ),
4350
							'%l = list of Jetpack module/feature names',
4351
							'jetpack'
4352
						),
4353
						$module_names
4354
					)
4355
				),
4356
				array( 'strong' => true )
4357
			);
4358
4359
			echo "\n<br />\n";
4360
4361
			echo wp_kses(
4362
				sprintf(
4363
					_nx(
4364
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4365
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4366
						count( $privacy_checks ),
4367
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4368
						'jetpack'
4369
					),
4370
					wp_nonce_url(
4371
						self::admin_url(
4372
							array(
4373
								'page'   => 'jetpack',
4374
								'action' => 'deactivate',
4375
								'module' => urlencode( $module_slugs ),
4376
							)
4377
						),
4378
						"jetpack_deactivate-$module_slugs"
4379
					),
4380
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4381
				),
4382
				array(
4383
					'a' => array(
4384
						'href'  => true,
4385
						'title' => true,
4386
					),
4387
				)
4388
			);
4389
			?>
4390
		</p>
4391
	</div>
4392
</div>
4393
			<?php
4394
endif;
4395
	}
4396
4397
	/**
4398
	 * We can't always respond to a signed XML-RPC request with a
4399
	 * helpful error message. In some circumstances, doing so could
4400
	 * leak information.
4401
	 *
4402
	 * Instead, track that the error occurred via a Jetpack_Option,
4403
	 * and send that data back in the heartbeat.
4404
	 * All this does is increment a number, but it's enough to find
4405
	 * trends.
4406
	 *
4407
	 * @param WP_Error $xmlrpc_error The error produced during
4408
	 *                               signature validation.
4409
	 */
4410
	function track_xmlrpc_error( $xmlrpc_error ) {
4411
		$code = is_wp_error( $xmlrpc_error )
4412
			? $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...
4413
			: 'should-not-happen';
4414
4415
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4416
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4417
			// No need to update the option if we already have
4418
			// this code stored.
4419
			return;
4420
		}
4421
		$xmlrpc_errors[ $code ] = true;
4422
4423
		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...
4424
	}
4425
4426
	/**
4427
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4428
	 */
4429
	function stat( $group, $detail ) {
4430
		if ( ! isset( $this->stats[ $group ] ) ) {
4431
			$this->stats[ $group ] = array();
4432
		}
4433
		$this->stats[ $group ][] = $detail;
4434
	}
4435
4436
	/**
4437
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4438
	 */
4439
	function do_stats( $method = '' ) {
4440
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4441
			foreach ( $this->stats as $group => $stats ) {
4442
				if ( is_array( $stats ) && count( $stats ) ) {
4443
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4444
					if ( 'server_side' === $method ) {
4445
						self::do_server_side_stat( $args );
4446
					} else {
4447
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4448
					}
4449
				}
4450
				unset( $this->stats[ $group ] );
4451
			}
4452
		}
4453
	}
4454
4455
	/**
4456
	 * Runs stats code for a one-off, server-side.
4457
	 *
4458
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4459
	 *
4460
	 * @return bool If it worked.
4461
	 */
4462
	static function do_server_side_stat( $args ) {
4463
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4464
		if ( is_wp_error( $response ) ) {
4465
			return false;
4466
		}
4467
4468
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4469
			return false;
4470
		}
4471
4472
		return true;
4473
	}
4474
4475
	/**
4476
	 * Builds the stats url.
4477
	 *
4478
	 * @param $args array|string The arguments to append to the URL.
4479
	 *
4480
	 * @return string The URL to be pinged.
4481
	 */
4482
	static function build_stats_url( $args ) {
4483
		$defaults = array(
4484
			'v'    => 'wpcom2',
4485
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4486
		);
4487
		$args     = wp_parse_args( $args, $defaults );
4488
		/**
4489
		 * Filter the URL used as the Stats tracking pixel.
4490
		 *
4491
		 * @since 2.3.2
4492
		 *
4493
		 * @param string $url Base URL used as the Stats tracking pixel.
4494
		 */
4495
		$base_url = apply_filters(
4496
			'jetpack_stats_base_url',
4497
			'https://pixel.wp.com/g.gif'
4498
		);
4499
		$url      = add_query_arg( $args, $base_url );
4500
		return $url;
4501
	}
4502
4503
	/**
4504
	 * Get the role of the current user.
4505
	 *
4506
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4507
	 *
4508
	 * @access public
4509
	 * @static
4510
	 *
4511
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4512
	 */
4513
	public static function translate_current_user_to_role() {
4514
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4515
4516
		$roles = new Roles();
4517
		return $roles->translate_current_user_to_role();
4518
	}
4519
4520
	/**
4521
	 * Get the role of a particular user.
4522
	 *
4523
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4524
	 *
4525
	 * @access public
4526
	 * @static
4527
	 *
4528
	 * @param \WP_User $user User object.
4529
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4530
	 */
4531
	public static function translate_user_to_role( $user ) {
4532
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4533
4534
		$roles = new Roles();
4535
		return $roles->translate_user_to_role( $user );
4536
	}
4537
4538
	/**
4539
	 * Get the minimum capability for a role.
4540
	 *
4541
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4542
	 *
4543
	 * @access public
4544
	 * @static
4545
	 *
4546
	 * @param string $role Role name.
4547
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4548
	 */
4549
	public static function translate_role_to_cap( $role ) {
4550
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4551
4552
		$roles = new Roles();
4553
		return $roles->translate_role_to_cap( $role );
4554
	}
4555
4556
	/**
4557
	 * Sign a user role with the master access token.
4558
	 * If not specified, will default to the current user.
4559
	 *
4560
	 * @deprecated since 7.7
4561
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4562
	 *
4563
	 * @access public
4564
	 * @static
4565
	 *
4566
	 * @param string $role    User role.
4567
	 * @param int    $user_id ID of the user.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|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...
4568
	 * @return string Signed user role.
4569
	 */
4570
	public static function sign_role( $role, $user_id = null ) {
4571
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4572
		return self::connection()->sign_role( $role, $user_id );
4573
	}
4574
4575
	/**
4576
	 * Builds a URL to the Jetpack connection auth page
4577
	 *
4578
	 * @since 3.9.5
4579
	 *
4580
	 * @param bool        $raw If true, URL will not be escaped.
4581
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4582
	 *                              If string, will be a custom redirect.
4583
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4584
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4585
	 *
4586
	 * @return string Connect URL
4587
	 */
4588
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4589
		$site_id    = Jetpack_Options::get_option( 'id' );
4590
		$blog_token = Jetpack_Data::get_access_token();
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

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...
4591
4592
		if ( $register || ! $blog_token || ! $site_id ) {
4593
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4594
4595
			if ( ! empty( $redirect ) ) {
4596
				$url = add_query_arg(
4597
					'redirect',
4598
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4599
					$url
4600
				);
4601
			}
4602
4603
			if ( is_network_admin() ) {
4604
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4605
			}
4606
4607
			$calypso_env = self::get_calypso_env();
4608
4609
			if ( ! empty( $calypso_env ) ) {
4610
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4611
			}
4612
		} else {
4613
4614
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4615
			// because otherwise this logic can get us in to a loop.
4616
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4617
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4618
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4619
4620
				$response = Client::wpcom_json_api_request_as_blog(
4621
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4622
					'1.1'
4623
				);
4624
4625
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4626
4627
					// Generating a register URL instead to refresh the existing token
4628
					return $this->build_connect_url( $raw, $redirect, $from, true );
4629
				}
4630
			}
4631
4632
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4588 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...
4633
		}
4634
4635
		if ( $from ) {
4636
			$url = add_query_arg( 'from', $from, $url );
4637
		}
4638
4639
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4640
		/**
4641
		 * Filter the URL used when connecting a user to a WordPress.com account.
4642
		 *
4643
		 * @since 8.1.0
4644
		 *
4645
		 * @param string $url Connection URL.
4646
		 * @param bool   $raw If true, URL will not be escaped.
4647
		 */
4648
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4649
	}
4650
4651
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4652
4653
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4654
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4655
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4656
4657
		if ( $iframe ) {
4658
			add_filter( 'jetpack_api_url', array( __CLASS__, 'filter_connect_api_iframe_url' ), 10, 2 );
4659
		}
4660
4661
		$c8n = self::connection();
4662
		$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...
4663
4664
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4665
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4666
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4667
4668
		if ( $iframe ) {
4669
			remove_filter( 'jetpack_api_url', array( __CLASS__, 'filter_connect_api_iframe_url' ) );
4670
		}
4671
4672
		return $url;
4673
	}
4674
4675
	/**
4676
	 * Filters the connection URL parameter array.
4677
	 *
4678
	 * @param Array $args default URL parameters used by the package.
4679
	 * @return Array the modified URL arguments array.
4680
	 */
4681
	public static function filter_connect_request_body( $args ) {
4682
		if (
4683
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4684
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4685
		) {
4686
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4687
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4688
				? $gp_locale->slug
4689
				: '';
4690
		}
4691
4692
		$tracking        = new Tracking();
4693
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4694
4695
		$args = array_merge(
4696
			$args,
4697
			array(
4698
				'_ui' => $tracks_identity['_ui'],
4699
				'_ut' => $tracks_identity['_ut'],
4700
			)
4701
		);
4702
4703
		$calypso_env = self::get_calypso_env();
4704
4705
		if ( ! empty( $calypso_env ) ) {
4706
			$args['calypso_env'] = $calypso_env;
4707
		}
4708
4709
		return $args;
4710
	}
4711
4712
	/**
4713
	 * Filters the URL that will process the connection data. It can be different from the URL
4714
	 * that we send the user to after everything is done.
4715
	 *
4716
	 * @param String $processing_url the default redirect URL used by the package.
4717
	 * @return String the modified URL.
4718
	 */
4719
	public static function filter_connect_processing_url( $processing_url ) {
4720
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4721
		return $processing_url;
4722
	}
4723
4724
	/**
4725
	 * Filters the redirection URL that is used for connect requests. The redirect
4726
	 * URL should return the user back to the Jetpack console.
4727
	 *
4728
	 * @param String $redirect the default redirect URL used by the package.
4729
	 * @return String the modified URL.
4730
	 */
4731
	public static function filter_connect_redirect_url( $redirect ) {
4732
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4733
		$redirect           = $redirect
4734
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4735
			: $jetpack_admin_page;
4736
4737
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4738
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4739
		}
4740
4741
		return $redirect;
4742
	}
4743
4744
	/**
4745
	 * Filters the API URL that is used for connect requests. The method
4746
	 * intercepts only the authorize URL and replaces it with another if needed.
4747
	 *
4748
	 * @param String $api_url the default redirect API URL used by the package.
4749
	 * @param String $relative_url the path of the URL that's being used.
4750
	 * @return String the modified URL.
4751
	 */
4752
	public static function filter_connect_api_iframe_url( $api_url, $relative_url ) {
4753
4754
		// Short-circuit on anything that is not related to connect requests.
4755
		if ( 'authorize' !== $relative_url ) {
4756
			return $api_url;
4757
		}
4758
4759
		$c8n = self::connection();
4760
4761
		return $c8n->api_url( 'authorize_iframe' );
4762
	}
4763
4764
	/**
4765
	 * This action fires at the beginning of the Manager::authorize method.
4766
	 */
4767
	public static function authorize_starting() {
4768
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4769
		// Checking if site has been active/connected previously before recording unique connection.
4770
		if ( ! $jetpack_unique_connection ) {
4771
			// jetpack_unique_connection option has never been set.
4772
			$jetpack_unique_connection = array(
4773
				'connected'    => 0,
4774
				'disconnected' => 0,
4775
				'version'      => '3.6.1',
4776
			);
4777
4778
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4779
4780
			// Track unique connection.
4781
			$jetpack = self::init();
4782
4783
			$jetpack->stat( 'connections', 'unique-connection' );
4784
			$jetpack->do_stats( 'server_side' );
4785
		}
4786
4787
		// Increment number of times connected.
4788
		$jetpack_unique_connection['connected'] += 1;
4789
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4790
	}
4791
4792
	/**
4793
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4794
	 * linked.
4795
	 */
4796
	public static function authorize_ending_linked() {
4797
		// Don't activate anything since we are just connecting a user.
4798
		self::state( 'message', 'linked' );
4799
	}
4800
4801
	/**
4802
	 * This action fires at the end of the Manager::authorize method when the master user is
4803
	 * authorized.
4804
	 *
4805
	 * @param array $data The request data.
4806
	 */
4807
	public static function authorize_ending_authorized( $data ) {
4808
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4809
		self::invalidate_onboarding_token();
4810
4811
		// If redirect_uri is SSO, ensure SSO module is enabled.
4812
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
4813
4814
		/** This filter is documented in class.jetpack-cli.php */
4815
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4816
4817
		$activate_sso = (
4818
			isset( $redirect_options['action'] ) &&
4819
			'jetpack-sso' === $redirect_options['action'] &&
4820
			$jetpack_start_enable_sso
4821
		);
4822
4823
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4824
4825
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4826
	}
4827
4828
	/**
4829
	 * Get our assumed site creation date.
4830
	 * Calculated based on the earlier date of either:
4831
	 * - Earliest admin user registration date.
4832
	 * - Earliest date of post of any post type.
4833
	 *
4834
	 * @since 7.2.0
4835
	 * @deprecated since 7.8.0
4836
	 *
4837
	 * @return string Assumed site creation date and time.
4838
	 */
4839
	public static function get_assumed_site_creation_date() {
4840
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4841
		return self::connection()->get_assumed_site_creation_date();
4842
	}
4843
4844 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4845
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4846
4847
		if ( $activation_source_name ) {
4848
			$args['_as'] = urlencode( $activation_source_name );
4849
		}
4850
4851
		if ( $activation_source_keyword ) {
4852
			$args['_ak'] = urlencode( $activation_source_keyword );
4853
		}
4854
	}
4855
4856
	function build_reconnect_url( $raw = false ) {
4857
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4858
		return $raw ? $url : esc_url( $url );
4859
	}
4860
4861
	public static function admin_url( $args = null ) {
4862
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4863
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4864
		return $url;
4865
	}
4866
4867
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4868
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4869
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4870
	}
4871
4872
	function dismiss_jetpack_notice() {
4873
4874
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4875
			return;
4876
		}
4877
4878
		switch ( $_GET['jetpack-notice'] ) {
4879
			case 'dismiss':
4880
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4881
4882
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4883
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4884
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4885
				}
4886
				break;
4887
		}
4888
	}
4889
4890
	public static function sort_modules( $a, $b ) {
4891
		if ( $a['sort'] == $b['sort'] ) {
4892
			return 0;
4893
		}
4894
4895
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4896
	}
4897
4898
	function ajax_recheck_ssl() {
4899
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4900
		$result = self::permit_ssl( true );
4901
		wp_send_json(
4902
			array(
4903
				'enabled' => $result,
4904
				'message' => get_transient( 'jetpack_https_test_message' ),
4905
			)
4906
		);
4907
	}
4908
4909
	/* Client API */
4910
4911
	/**
4912
	 * Returns the requested Jetpack API URL
4913
	 *
4914
	 * @deprecated since 7.7
4915
	 * @return string
4916
	 */
4917
	public static function api_url( $relative_url ) {
4918
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
4919
		$connection = self::connection();
4920
		return $connection->api_url( $relative_url );
4921
	}
4922
4923
	/**
4924
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
4925
	 *
4926
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4927
	 */
4928
	public static function fix_url_for_bad_hosts( $url ) {
4929
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
4930
		return Connection_Utils::fix_url_for_bad_hosts( $url );
4931
	}
4932
4933
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
4934
		// Default to a blog token.
4935
		$token_type = 'blog';
4936
4937
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
4938
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
4939
			if ( ! empty( $_GET['onboarding'] ) ) {
4940
				$jpo = $_GET;
4941
			} else {
4942
				$jpo = json_decode( $request_data, true );
4943
			}
4944
4945
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
4946
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
4947
4948
			if (
4949
				isset( $jpo_user )
4950
				&& isset( $jpo_token )
4951
				&& is_email( $jpo_user )
4952
				&& ctype_alnum( $jpo_token )
4953
				&& isset( $_GET['rest_route'] )
4954
				&& self::validate_onboarding_token_action(
4955
					$jpo_token,
4956
					$_GET['rest_route']
4957
				)
4958
			) {
4959
				$jp_user = get_user_by( 'email', $jpo_user );
4960
				if ( is_a( $jp_user, 'WP_User' ) ) {
4961
					wp_set_current_user( $jp_user->ID );
4962
					$user_can = is_multisite()
4963
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
4964
						: current_user_can( 'manage_options' );
4965
					if ( $user_can ) {
4966
						$token_type              = 'user';
4967
						$token->external_user_id = $jp_user->ID;
4968
					}
4969
				}
4970
			}
4971
4972
			$token_data['type']    = $token_type;
4973
			$token_data['user_id'] = $token->external_user_id;
4974
		}
4975
4976
		return $token_data;
4977
	}
4978
4979
	/**
4980
	 * Create a random secret for validating onboarding payload
4981
	 *
4982
	 * @return string Secret token
4983
	 */
4984
	public static function create_onboarding_token() {
4985
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4986
			$token = wp_generate_password( 32, false );
4987
			Jetpack_Options::update_option( 'onboarding', $token );
4988
		}
4989
4990
		return $token;
4991
	}
4992
4993
	/**
4994
	 * Remove the onboarding token
4995
	 *
4996
	 * @return bool True on success, false on failure
4997
	 */
4998
	public static function invalidate_onboarding_token() {
4999
		return Jetpack_Options::delete_option( 'onboarding' );
5000
	}
5001
5002
	/**
5003
	 * Validate an onboarding token for a specific action
5004
	 *
5005
	 * @return boolean True if token/action pair is accepted, false if not
5006
	 */
5007
	public static function validate_onboarding_token_action( $token, $action ) {
5008
		// Compare tokens, bail if tokens do not match
5009
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5010
			return false;
5011
		}
5012
5013
		// List of valid actions we can take
5014
		$valid_actions = array(
5015
			'/jetpack/v4/settings',
5016
		);
5017
5018
		// Whitelist the action
5019
		if ( ! in_array( $action, $valid_actions ) ) {
5020
			return false;
5021
		}
5022
5023
		return true;
5024
	}
5025
5026
	/**
5027
	 * Checks to see if the URL is using SSL to connect with Jetpack
5028
	 *
5029
	 * @since 2.3.3
5030
	 * @return boolean
5031
	 */
5032
	public static function permit_ssl( $force_recheck = false ) {
5033
		// Do some fancy tests to see if ssl is being supported
5034
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5035
			$message = '';
5036
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5037
				$ssl = 0;
5038
			} else {
5039
				switch ( JETPACK_CLIENT__HTTPS ) {
5040
					case 'NEVER':
5041
						$ssl     = 0;
5042
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5043
						break;
5044
					case 'ALWAYS':
5045
					case 'AUTO':
5046
					default:
5047
						$ssl = 1;
5048
						break;
5049
				}
5050
5051
				// If it's not 'NEVER', test to see
5052
				if ( $ssl ) {
5053
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5054
						$ssl     = 0;
5055
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5056
					} else {
5057
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5058
						if ( is_wp_error( $response ) ) {
5059
							$ssl     = 0;
5060
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5061
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5062
							$ssl     = 0;
5063
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5064
						}
5065
					}
5066
				}
5067
			}
5068
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5069
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5070
		}
5071
5072
		return (bool) $ssl;
5073
	}
5074
5075
	/*
5076
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5077
	 */
5078
	public function alert_auto_ssl_fail() {
5079
		if ( ! current_user_can( 'manage_options' ) ) {
5080
			return;
5081
		}
5082
5083
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5084
		?>
5085
5086
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5087
			<div class="jp-banner__content">
5088
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5089
				<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>
5090
				<p>
5091
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5092
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5093
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5094
				</p>
5095
				<p>
5096
					<?php
5097
					printf(
5098
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5099
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5100
						esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' )
5101
					);
5102
					?>
5103
				</p>
5104
			</div>
5105
		</div>
5106
		<style>
5107
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5108
		</style>
5109
		<script type="text/javascript">
5110
			jQuery( document ).ready( function( $ ) {
5111
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5112
					var $this = $( this );
5113
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5114
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5115
					e.preventDefault();
5116
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5117
					$.post( ajaxurl, data )
5118
					  .done( function( response ) {
5119
						  if ( response.enabled ) {
5120
							  $( '#jetpack-ssl-warning' ).hide();
5121
						  } else {
5122
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5123
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5124
						  }
5125
					  }.bind( $this ) );
5126
				} );
5127
			} );
5128
		</script>
5129
5130
		<?php
5131
	}
5132
5133
	/**
5134
	 * Returns the Jetpack XML-RPC API
5135
	 *
5136
	 * @deprecated 8.0 Use Connection_Manager instead.
5137
	 * @return string
5138
	 */
5139
	public static function xmlrpc_api_url() {
5140
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5141
		return self::connection()->xmlrpc_api_url();
5142
	}
5143
5144
	/**
5145
	 * Returns the connection manager object.
5146
	 *
5147
	 * @return Automattic\Jetpack\Connection\Manager
5148
	 */
5149
	public static function connection() {
5150
		return self::init()->connection_manager;
5151
	}
5152
5153
	/**
5154
	 * Creates two secret tokens and the end of life timestamp for them.
5155
	 *
5156
	 * Note these tokens are unique per call, NOT static per site for connecting.
5157
	 *
5158
	 * @since 2.6
5159
	 * @param String  $action  The action name.
5160
	 * @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...
5161
	 * @param Integer $exp     Expiration time in seconds.
5162
	 * @return array
5163
	 */
5164
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5165
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5166
	}
5167
5168
	public static function get_secrets( $action, $user_id ) {
5169
		$secrets = self::connection()->get_secrets( $action, $user_id );
5170
5171
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5172
			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...
5173
		}
5174
5175
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5176
			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...
5177
		}
5178
5179
		return $secrets;
5180
	}
5181
5182
	/**
5183
	 * @deprecated 7.5 Use Connection_Manager instead.
5184
	 *
5185
	 * @param $action
5186
	 * @param $user_id
5187
	 */
5188
	public static function delete_secrets( $action, $user_id ) {
5189
		return self::connection()->delete_secrets( $action, $user_id );
5190
	}
5191
5192
	/**
5193
	 * Builds the timeout limit for queries talking with the wpcom servers.
5194
	 *
5195
	 * Based on local php max_execution_time in php.ini
5196
	 *
5197
	 * @since 2.6
5198
	 * @return int
5199
	 * @deprecated
5200
	 **/
5201
	public function get_remote_query_timeout_limit() {
5202
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5203
		return self::get_max_execution_time();
5204
	}
5205
5206
	/**
5207
	 * Builds the timeout limit for queries talking with the wpcom servers.
5208
	 *
5209
	 * Based on local php max_execution_time in php.ini
5210
	 *
5211
	 * @since 5.4
5212
	 * @return int
5213
	 **/
5214
	public static function get_max_execution_time() {
5215
		$timeout = (int) ini_get( 'max_execution_time' );
5216
5217
		// Ensure exec time set in php.ini
5218
		if ( ! $timeout ) {
5219
			$timeout = 30;
5220
		}
5221
		return $timeout;
5222
	}
5223
5224
	/**
5225
	 * Sets a minimum request timeout, and returns the current timeout
5226
	 *
5227
	 * @since 5.4
5228
	 **/
5229 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5230
		$timeout = self::get_max_execution_time();
5231
		if ( $timeout < $min_timeout ) {
5232
			$timeout = $min_timeout;
5233
			set_time_limit( $timeout );
5234
		}
5235
		return $timeout;
5236
	}
5237
5238
	/**
5239
	 * Takes the response from the Jetpack register new site endpoint and
5240
	 * verifies it worked properly.
5241
	 *
5242
	 * @since 2.6
5243
	 * @deprecated since 7.7.0
5244
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5245
	 **/
5246
	public function validate_remote_register_response() {
5247
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5248
	}
5249
5250
	/**
5251
	 * @return bool|WP_Error
5252
	 */
5253
	public static function register() {
5254
		$tracking = new Tracking();
5255
		$tracking->record_user_event( 'jpc_register_begin' );
5256
5257
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5258
5259
		$connection   = self::connection();
5260
		$registration = $connection->register();
5261
5262
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5263
5264
		if ( ! $registration || is_wp_error( $registration ) ) {
5265
			return $registration;
5266
		}
5267
5268
		return true;
5269
	}
5270
5271
	/**
5272
	 * Filters the registration request body to include tracking properties.
5273
	 *
5274
	 * @param Array $properties
5275
	 * @return Array amended properties.
5276
	 */
5277 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5278
		$tracking        = new Tracking();
5279
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5280
5281
		return array_merge(
5282
			$properties,
5283
			array(
5284
				'_ui' => $tracks_identity['_ui'],
5285
				'_ut' => $tracks_identity['_ut'],
5286
			)
5287
		);
5288
	}
5289
5290
	/**
5291
	 * Filters the token request body to include tracking properties.
5292
	 *
5293
	 * @param Array $properties
5294
	 * @return Array amended properties.
5295
	 */
5296 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5297
		$tracking        = new Tracking();
5298
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5299
5300
		return array_merge(
5301
			$properties,
5302
			array(
5303
				'_ui' => $tracks_identity['_ui'],
5304
				'_ut' => $tracks_identity['_ut'],
5305
			)
5306
		);
5307
	}
5308
5309
	/**
5310
	 * If the db version is showing something other that what we've got now, bump it to current.
5311
	 *
5312
	 * @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...
5313
	 */
5314
	public static function maybe_set_version_option() {
5315
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5316
		if ( JETPACK__VERSION != $version ) {
5317
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5318
5319
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5320
				/** This action is documented in class.jetpack.php */
5321
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5322
			}
5323
5324
			return true;
5325
		}
5326
		return false;
5327
	}
5328
5329
	/* Client Server API */
5330
5331
	/**
5332
	 * Loads the Jetpack XML-RPC client.
5333
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5334
	 *
5335
	 * @deprecated since 7.7.0
5336
	 */
5337
	public static function load_xml_rpc_client() {
5338
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5339
	}
5340
5341
	/**
5342
	 * Resets the saved authentication state in between testing requests.
5343
	 */
5344
	public function reset_saved_auth_state() {
5345
		$this->rest_authentication_status = null;
5346
		$this->connection_manager->reset_saved_auth_state();
5347
	}
5348
5349
	/**
5350
	 * Verifies the signature of the current request.
5351
	 *
5352
	 * @deprecated since 7.7.0
5353
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5354
	 *
5355
	 * @return false|array
5356
	 */
5357
	public function verify_xml_rpc_signature() {
5358
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5359
		return self::connection()->verify_xml_rpc_signature();
5360
	}
5361
5362
	/**
5363
	 * Verifies the signature of the current request.
5364
	 *
5365
	 * This function has side effects and should not be used. Instead,
5366
	 * use the memoized version `->verify_xml_rpc_signature()`.
5367
	 *
5368
	 * @deprecated since 7.7.0
5369
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5370
	 * @internal
5371
	 */
5372
	private function internal_verify_xml_rpc_signature() {
5373
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5374
	}
5375
5376
	/**
5377
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5378
	 *
5379
	 * @deprecated since 7.7.0
5380
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5381
	 *
5382
	 * @param \WP_User|mixed $user     User object if authenticated.
5383
	 * @param string         $username Username.
5384
	 * @param string         $password Password string.
5385
	 * @return \WP_User|mixed Authenticated user or error.
5386
	 */
5387
	public function authenticate_jetpack( $user, $username, $password ) {
5388
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5389
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5390
	}
5391
5392
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5393
	// Uses the existing XMLRPC request signing implementation.
5394
	function wp_rest_authenticate( $user ) {
5395
		if ( ! empty( $user ) ) {
5396
			// Another authentication method is in effect.
5397
			return $user;
5398
		}
5399
5400
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5401
			// Nothing to do for this authentication method.
5402
			return null;
5403
		}
5404
5405
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5406
			// Nothing to do for this authentication method.
5407
			return null;
5408
		}
5409
5410
		// Ensure that we always have the request body available.  At this
5411
		// point, the WP REST API code to determine the request body has not
5412
		// run yet.  That code may try to read from 'php://input' later, but
5413
		// this can only be done once per request in PHP versions prior to 5.6.
5414
		// So we will go ahead and perform this read now if needed, and save
5415
		// the request body where both the Jetpack signature verification code
5416
		// and the WP REST API code can see it.
5417
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5418
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5419
		}
5420
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5421
5422
		// Only support specific request parameters that have been tested and
5423
		// are known to work with signature verification.  A different method
5424
		// can be passed to the WP REST API via the '?_method=' parameter if
5425
		// needed.
5426
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5427
			$this->rest_authentication_status = new WP_Error(
5428
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

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...
5429
				__( 'This request method is not supported.', 'jetpack' ),
5430
				array( 'status' => 400 )
5431
			);
5432
			return null;
5433
		}
5434
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5435
			$this->rest_authentication_status = new WP_Error(
5436
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

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...
5437
				__( 'This request method does not support body parameters.', 'jetpack' ),
5438
				array( 'status' => 400 )
5439
			);
5440
			return null;
5441
		}
5442
5443
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5444
5445
		if (
5446
			$verified &&
5447
			isset( $verified['type'] ) &&
5448
			'user' === $verified['type'] &&
5449
			! empty( $verified['user_id'] )
5450
		) {
5451
			// Authentication successful.
5452
			$this->rest_authentication_status = true;
5453
			return $verified['user_id'];
5454
		}
5455
5456
		// Something else went wrong.  Probably a signature error.
5457
		$this->rest_authentication_status = new WP_Error(
5458
			'rest_invalid_signature',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_signature'.

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

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

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

Loading history...
5459
			__( 'The request is not signed correctly.', 'jetpack' ),
5460
			array( 'status' => 400 )
5461
		);
5462
		return null;
5463
	}
5464
5465
	/**
5466
	 * Report authentication status to the WP REST API.
5467
	 *
5468
	 * @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...
5469
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5470
	 */
5471
	public function wp_rest_authentication_errors( $value ) {
5472
		if ( $value !== null ) {
5473
			return $value;
5474
		}
5475
		return $this->rest_authentication_status;
5476
	}
5477
5478
	/**
5479
	 * Add our nonce to this request.
5480
	 *
5481
	 * @deprecated since 7.7.0
5482
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5483
	 *
5484
	 * @param int    $timestamp Timestamp of the request.
5485
	 * @param string $nonce     Nonce string.
5486
	 */
5487
	public function add_nonce( $timestamp, $nonce ) {
5488
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5489
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5490
	}
5491
5492
	/**
5493
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5494
	 * Capture it here so we can verify the signature later.
5495
	 *
5496
	 * @deprecated since 7.7.0
5497
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5498
	 *
5499
	 * @param array $methods XMLRPC methods.
5500
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5501
	 */
5502
	public function xmlrpc_methods( $methods ) {
5503
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5504
		return $this->connection_manager->xmlrpc_methods( $methods );
5505
	}
5506
5507
	/**
5508
	 * Register additional public XMLRPC methods.
5509
	 *
5510
	 * @deprecated since 7.7.0
5511
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5512
	 *
5513
	 * @param array $methods Public XMLRPC methods.
5514
	 * @return array Public XMLRPC methods, with the getOptions one.
5515
	 */
5516
	public function public_xmlrpc_methods( $methods ) {
5517
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5518
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5519
	}
5520
5521
	/**
5522
	 * Handles a getOptions XMLRPC method call.
5523
	 *
5524
	 * @deprecated since 7.7.0
5525
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5526
	 *
5527
	 * @param array $args method call arguments.
5528
	 * @return array an amended XMLRPC server options array.
5529
	 */
5530
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5531
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5532
		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...
5533
	}
5534
5535
	/**
5536
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5537
	 *
5538
	 * @deprecated since 7.7.0
5539
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5540
	 *
5541
	 * @param array $options Standard Core options.
5542
	 * @return array Amended options.
5543
	 */
5544
	public function xmlrpc_options( $options ) {
5545
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5546
		return $this->connection_manager->xmlrpc_options( $options );
5547
	}
5548
5549
	/**
5550
	 * Cleans nonces that were saved when calling ::add_nonce.
5551
	 *
5552
	 * @deprecated since 7.7.0
5553
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5554
	 *
5555
	 * @param bool $all whether to clean even non-expired nonces.
5556
	 */
5557
	public static function clean_nonces( $all = false ) {
5558
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5559
		return self::connection()->clean_nonces( $all );
5560
	}
5561
5562
	/**
5563
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5564
	 * SET: state( $key, $value );
5565
	 * GET: $value = state( $key );
5566
	 *
5567
	 * @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...
5568
	 * @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...
5569
	 * @param bool   $restate private
5570
	 */
5571
	public static function state( $key = null, $value = null, $restate = false ) {
5572
		static $state = array();
5573
		static $path, $domain;
5574
		if ( ! isset( $path ) ) {
5575
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5576
			$admin_url = self::admin_url();
5577
			$bits      = wp_parse_url( $admin_url );
5578
5579
			if ( is_array( $bits ) ) {
5580
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5581
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5582
			} else {
5583
				$path = $domain = null;
5584
			}
5585
		}
5586
5587
		// Extract state from cookies and delete cookies
5588
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5589
			$yum = $_COOKIE['jetpackState'];
5590
			unset( $_COOKIE['jetpackState'] );
5591
			foreach ( $yum as $k => $v ) {
5592
				if ( strlen( $v ) ) {
5593
					$state[ $k ] = $v;
5594
				}
5595
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5596
			}
5597
		}
5598
5599
		if ( $restate ) {
5600
			foreach ( $state as $k => $v ) {
5601
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5602
			}
5603
			return;
5604
		}
5605
5606
		// Get a state variable
5607
		if ( isset( $key ) && ! isset( $value ) ) {
5608
			if ( array_key_exists( $key, $state ) ) {
5609
				return $state[ $key ];
5610
			}
5611
			return null;
5612
		}
5613
5614
		// Set a state variable
5615
		if ( isset( $key ) && isset( $value ) ) {
5616
			if ( is_array( $value ) && isset( $value[0] ) ) {
5617
				$value = $value[0];
5618
			}
5619
			$state[ $key ] = $value;
5620
			if ( ! headers_sent() ) {
5621
				setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5622
			}
5623
		}
5624
	}
5625
5626
	public static function restate() {
5627
		self::state( null, null, true );
5628
	}
5629
5630
	public static function check_privacy( $file ) {
5631
		static $is_site_publicly_accessible = null;
5632
5633
		if ( is_null( $is_site_publicly_accessible ) ) {
5634
			$is_site_publicly_accessible = false;
5635
5636
			$rpc = new Jetpack_IXR_Client();
5637
5638
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5639
			if ( $success ) {
5640
				$response = $rpc->getResponse();
5641
				if ( $response ) {
5642
					$is_site_publicly_accessible = true;
5643
				}
5644
			}
5645
5646
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5647
		}
5648
5649
		if ( $is_site_publicly_accessible ) {
5650
			return;
5651
		}
5652
5653
		$module_slug = self::get_module_slug( $file );
5654
5655
		$privacy_checks = self::state( 'privacy_checks' );
5656
		if ( ! $privacy_checks ) {
5657
			$privacy_checks = $module_slug;
5658
		} else {
5659
			$privacy_checks .= ",$module_slug";
5660
		}
5661
5662
		self::state( 'privacy_checks', $privacy_checks );
5663
	}
5664
5665
	/**
5666
	 * Helper method for multicall XMLRPC.
5667
	 *
5668
	 * @param ...$args Args for the async_call.
5669
	 */
5670
	public static function xmlrpc_async_call( ...$args ) {
5671
		global $blog_id;
5672
		static $clients = array();
5673
5674
		$client_blog_id = is_multisite() ? $blog_id : 0;
5675
5676
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5677
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5678
			if ( function_exists( 'ignore_user_abort' ) ) {
5679
				ignore_user_abort( true );
5680
			}
5681
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5682
		}
5683
5684
		if ( ! empty( $args[0] ) ) {
5685
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5686
		} elseif ( is_multisite() ) {
5687
			foreach ( $clients as $client_blog_id => $client ) {
5688
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5689
					continue;
5690
				}
5691
5692
				$switch_success = switch_to_blog( $client_blog_id, true );
5693
				if ( ! $switch_success ) {
5694
					continue;
5695
				}
5696
5697
				flush();
5698
				$client->query();
5699
5700
				restore_current_blog();
5701
			}
5702
		} else {
5703
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5704
				flush();
5705
				$clients[0]->query();
5706
			}
5707
		}
5708
	}
5709
5710
	public static function staticize_subdomain( $url ) {
5711
5712
		// Extract hostname from URL
5713
		$host = wp_parse_url( $url, PHP_URL_HOST );
5714
5715
		// Explode hostname on '.'
5716
		$exploded_host = explode( '.', $host );
5717
5718
		// Retrieve the name and TLD
5719
		if ( count( $exploded_host ) > 1 ) {
5720
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5721
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5722
			// Rebuild domain excluding subdomains
5723
			$domain = $name . '.' . $tld;
5724
		} else {
5725
			$domain = $host;
5726
		}
5727
		// Array of Automattic domains
5728
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5729
5730
		// Return $url if not an Automattic domain
5731
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5732
			return $url;
5733
		}
5734
5735
		if ( is_ssl() ) {
5736
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5737
		}
5738
5739
		srand( crc32( basename( $url ) ) );
5740
		$static_counter = rand( 0, 2 );
5741
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5742
5743
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5744
	}
5745
5746
	/* JSON API Authorization */
5747
5748
	/**
5749
	 * Handles the login action for Authorizing the JSON API
5750
	 */
5751
	function login_form_json_api_authorization() {
5752
		$this->verify_json_api_authorization_request();
5753
5754
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5755
5756
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5757
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5758
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5759
	}
5760
5761
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5762
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5763
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5764
			return $url;
5765
		}
5766
5767
		$parsed_url = wp_parse_url( $url );
5768
		$url        = strtok( $url, '?' );
5769
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5770
		if ( ! empty( $parsed_url['query'] ) ) {
5771
			$url .= "&{$parsed_url['query']}";
5772
		}
5773
5774
		return $url;
5775
	}
5776
5777
	// Make sure the POSTed request is handled by the same action
5778
	function preserve_action_in_login_form_for_json_api_authorization() {
5779
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5780
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5781
	}
5782
5783
	// If someone logs in to approve API access, store the Access Code in usermeta
5784
	function store_json_api_authorization_token( $user_login, $user ) {
5785
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5786
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5787
		$token = wp_generate_password( 32, false );
5788
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5789
	}
5790
5791
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5792
	function allow_wpcom_public_api_domain( $domains ) {
5793
		$domains[] = 'public-api.wordpress.com';
5794
		return $domains;
5795
	}
5796
5797
	static function is_redirect_encoded( $redirect_url ) {
5798
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5799
	}
5800
5801
	// Add all wordpress.com environments to the safe redirect whitelist
5802
	function allow_wpcom_environments( $domains ) {
5803
		$domains[] = 'wordpress.com';
5804
		$domains[] = 'wpcalypso.wordpress.com';
5805
		$domains[] = 'horizon.wordpress.com';
5806
		$domains[] = 'calypso.localhost';
5807
		return $domains;
5808
	}
5809
5810
	// Add the Access Code details to the public-api.wordpress.com redirect
5811
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5812
		return add_query_arg(
5813
			urlencode_deep(
5814
				array(
5815
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5816
					'jetpack-user-id' => (int) $user->ID,
5817
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5818
				)
5819
			),
5820
			$redirect_to
5821
		);
5822
	}
5823
5824
5825
	/**
5826
	 * Verifies the request by checking the signature
5827
	 *
5828
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5829
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5830
	 *
5831
	 * @param null|array $environment
5832
	 */
5833
	function verify_json_api_authorization_request( $environment = null ) {
5834
		$environment = is_null( $environment )
5835
			? $_REQUEST
5836
			: $environment;
5837
5838
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envVersion 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...
5839
		$token                                     = Jetpack_Data::get_access_token( $envUserId, $envToken );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

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...
5840
		if ( ! $token || empty( $token->secret ) ) {
5841
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5842
		}
5843
5844
		$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' );
5845
5846
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5847
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5848
			/**
5849
			 * Jetpack authorisation request Error.
5850
			 *
5851
			 * @since 7.5.0
5852
			 */
5853
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5854
			$die_error = sprintf(
5855
				/* translators: %s is a URL */
5856
				__( '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' ),
5857
				'https://jetpack.com/support/double-encoding/'
5858
			);
5859
		}
5860
5861
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5862
5863
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5864
			$signature = $jetpack_signature->sign_request(
5865
				$environment['token'],
5866
				$environment['timestamp'],
5867
				$environment['nonce'],
5868
				'',
5869
				'GET',
5870
				$environment['jetpack_json_api_original_query'],
5871
				null,
5872
				true
5873
			);
5874
		} else {
5875
			$signature = $jetpack_signature->sign_current_request(
5876
				array(
5877
					'body'   => null,
5878
					'method' => 'GET',
5879
				)
5880
			);
5881
		}
5882
5883
		if ( ! $signature ) {
5884
			wp_die( $die_error );
5885
		} elseif ( is_wp_error( $signature ) ) {
5886
			wp_die( $die_error );
5887
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
5888
			if ( is_ssl() ) {
5889
				// 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
5890
				$signature = $jetpack_signature->sign_current_request(
5891
					array(
5892
						'scheme' => 'http',
5893
						'body'   => null,
5894
						'method' => 'GET',
5895
					)
5896
				);
5897
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5898
					wp_die( $die_error );
5899
				}
5900
			} else {
5901
				wp_die( $die_error );
5902
			}
5903
		}
5904
5905
		$timestamp = (int) $environment['timestamp'];
5906
		$nonce     = stripslashes( (string) $environment['nonce'] );
5907
5908
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
5909
			// De-nonce the nonce, at least for 5 minutes.
5910
			// 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)
5911
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5912
			if ( $old_nonce_time < time() - 300 ) {
5913
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
5914
			}
5915
		}
5916
5917
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5918
		$data_filters = array(
5919
			'state'        => 'opaque',
5920
			'client_id'    => 'int',
5921
			'client_title' => 'string',
5922
			'client_image' => 'url',
5923
		);
5924
5925
		foreach ( $data_filters as $key => $sanitation ) {
5926
			if ( ! isset( $data->$key ) ) {
5927
				wp_die( $die_error );
5928
			}
5929
5930
			switch ( $sanitation ) {
5931
				case 'int':
5932
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
5933
					break;
5934
				case 'opaque':
5935
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
5936
					break;
5937
				case 'string':
5938
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
5939
					break;
5940
				case 'url':
5941
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
5942
					break;
5943
			}
5944
		}
5945
5946
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5947
			wp_die( $die_error );
5948
		}
5949
	}
5950
5951
	function login_message_json_api_authorization( $message ) {
5952
		return '<p class="message">' . sprintf(
5953
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
5954
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5955
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5956
	}
5957
5958
	/**
5959
	 * Get $content_width, but with a <s>twist</s> filter.
5960
	 */
5961
	public static function get_content_width() {
5962
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5963
			? $GLOBALS['content_width']
5964
			: false;
5965
		/**
5966
		 * Filter the Content Width value.
5967
		 *
5968
		 * @since 2.2.3
5969
		 *
5970
		 * @param string $content_width Content Width value.
5971
		 */
5972
		return apply_filters( 'jetpack_content_width', $content_width );
5973
	}
5974
5975
	/**
5976
	 * Pings the WordPress.com Mirror Site for the specified options.
5977
	 *
5978
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5979
	 *
5980
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5981
	 */
5982
	public function get_cloud_site_options( $option_names ) {
5983
		$option_names = array_filter( (array) $option_names, 'is_string' );
5984
5985
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
5986
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5987
		if ( $xml->isError() ) {
5988
			return array(
5989
				'error_code' => $xml->getErrorCode(),
5990
				'error_msg'  => $xml->getErrorMessage(),
5991
			);
5992
		}
5993
		$cloud_site_options = $xml->getResponse();
5994
5995
		return $cloud_site_options;
5996
	}
5997
5998
	/**
5999
	 * Checks if the site is currently in an identity crisis.
6000
	 *
6001
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6002
	 */
6003
	public static function check_identity_crisis() {
6004
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6005
			return false;
6006
		}
6007
6008
		return Jetpack_Options::get_option( 'sync_error_idc' );
6009
	}
6010
6011
	/**
6012
	 * Checks whether the home and siteurl specifically are whitelisted
6013
	 * Written so that we don't have re-check $key and $value params every time
6014
	 * we want to check if this site is whitelisted, for example in footer.php
6015
	 *
6016
	 * @since  3.8.0
6017
	 * @return bool True = already whitelisted False = not whitelisted
6018
	 */
6019
	public static function is_staging_site() {
6020
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6021
		return ( new Status() )->is_staging_site();
6022
	}
6023
6024
	/**
6025
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6026
	 *
6027
	 * @since 4.4.0
6028
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6029
	 *
6030
	 * @return bool
6031
	 */
6032
	public static function validate_sync_error_idc_option() {
6033
		$is_valid = false;
6034
6035
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6036
		if ( false === $idc_allowed ) {
6037
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6038
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6039
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6040
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6041
				$transient_duration = HOUR_IN_SECONDS;
6042
			} else {
6043
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6044
				$idc_allowed        = '1';
6045
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6046
			}
6047
6048
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6049
		}
6050
6051
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6052
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6053
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6054
			$local_options = self::get_sync_error_idc_option();
6055
			// Ensure all values are set.
6056
			if ( isset( $sync_error['home'] ) && isset ( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6057
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6058
					$is_valid = true;
6059
				}
6060
			}
6061
6062
		}
6063
6064
		/**
6065
		 * Filters whether the sync_error_idc option is valid.
6066
		 *
6067
		 * @since 4.4.0
6068
		 *
6069
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6070
		 */
6071
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6072
6073
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6074
			// Since the option exists, and did not validate, delete it
6075
			Jetpack_Options::delete_option( 'sync_error_idc' );
6076
		}
6077
6078
		return $is_valid;
6079
	}
6080
6081
	/**
6082
	 * Normalizes a url by doing three things:
6083
	 *  - Strips protocol
6084
	 *  - Strips www
6085
	 *  - Adds a trailing slash
6086
	 *
6087
	 * @since 4.4.0
6088
	 * @param string $url
6089
	 * @return WP_Error|string
6090
	 */
6091
	public static function normalize_url_protocol_agnostic( $url ) {
6092
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6093
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6094
			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...
6095
		}
6096
6097
		// Strip www and protocols
6098
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6099
		return $url;
6100
	}
6101
6102
	/**
6103
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6104
	 *
6105
	 * @since 4.4.0
6106
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6107
	 *
6108
	 * @param array $response
6109
	 * @return array Array of the local urls, wpcom urls, and error code
6110
	 */
6111
	public static function get_sync_error_idc_option( $response = array() ) {
6112
		// Since the local options will hit the database directly, store the values
6113
		// in a transient to allow for autoloading and caching on subsequent views.
6114
		$local_options = get_transient( 'jetpack_idc_local' );
6115
		if ( false === $local_options ) {
6116
			$local_options = array(
6117
				'home'    => Functions::home_url(),
6118
				'siteurl' => Functions::site_url(),
6119
			);
6120
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6121
		}
6122
6123
		$options = array_merge( $local_options, $response );
6124
6125
		$returned_values = array();
6126
		foreach ( $options as $key => $option ) {
6127
			if ( 'error_code' === $key ) {
6128
				$returned_values[ $key ] = $option;
6129
				continue;
6130
			}
6131
6132
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6133
				continue;
6134
			}
6135
6136
			$returned_values[ $key ] = $normalized_url;
6137
		}
6138
6139
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6140
6141
		return $returned_values;
6142
	}
6143
6144
	/**
6145
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6146
	 * If set to true, the site will be put into staging mode.
6147
	 *
6148
	 * @since 4.3.2
6149
	 * @return bool
6150
	 */
6151
	public static function sync_idc_optin() {
6152
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6153
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6154
		} else {
6155
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6156
		}
6157
6158
		/**
6159
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6160
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6161
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6162
		 *
6163
		 * @since 4.3.2
6164
		 *
6165
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6166
		 */
6167
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6168
	}
6169
6170
	/**
6171
	 * Maybe Use a .min.css stylesheet, maybe not.
6172
	 *
6173
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6174
	 */
6175
	public static function maybe_min_asset( $url, $path, $plugin ) {
6176
		// Short out on things trying to find actual paths.
6177
		if ( ! $path || empty( $plugin ) ) {
6178
			return $url;
6179
		}
6180
6181
		$path = ltrim( $path, '/' );
6182
6183
		// Strip out the abspath.
6184
		$base = dirname( plugin_basename( $plugin ) );
6185
6186
		// Short out on non-Jetpack assets.
6187
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6188
			return $url;
6189
		}
6190
6191
		// File name parsing.
6192
		$file              = "{$base}/{$path}";
6193
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6194
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6195
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6196
		$extension         = array_shift( $file_name_parts_r );
6197
6198
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6199
			// Already pointing at the minified version.
6200
			if ( 'min' === $file_name_parts_r[0] ) {
6201
				return $url;
6202
			}
6203
6204
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6205
			if ( file_exists( $min_full_path ) ) {
6206
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6207
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6208
				if ( 'css' === $extension ) {
6209
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6210
					self::$min_assets[ $key ] = $path;
6211
				}
6212
			}
6213
		}
6214
6215
		return $url;
6216
	}
6217
6218
	/**
6219
	 * If the asset is minified, let's flag .min as the suffix.
6220
	 *
6221
	 * Attached to `style_loader_src` filter.
6222
	 *
6223
	 * @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...
6224
	 * @param string $handle The registered handle of the script in question.
6225
	 * @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...
6226
	 */
6227
	public static function set_suffix_on_min( $src, $handle ) {
6228
		if ( false === strpos( $src, '.min.css' ) ) {
6229
			return $src;
6230
		}
6231
6232
		if ( ! empty( self::$min_assets ) ) {
6233
			foreach ( self::$min_assets as $file => $path ) {
6234
				if ( false !== strpos( $src, $file ) ) {
6235
					wp_style_add_data( $handle, 'suffix', '.min' );
6236
					return $src;
6237
				}
6238
			}
6239
		}
6240
6241
		return $src;
6242
	}
6243
6244
	/**
6245
	 * Maybe inlines a stylesheet.
6246
	 *
6247
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6248
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6249
	 *
6250
	 * Attached to `style_loader_tag` filter.
6251
	 *
6252
	 * @param string $tag The tag that would link to the external asset.
6253
	 * @param string $handle The registered handle of the script in question.
6254
	 *
6255
	 * @return string
6256
	 */
6257
	public static function maybe_inline_style( $tag, $handle ) {
6258
		global $wp_styles;
6259
		$item = $wp_styles->registered[ $handle ];
6260
6261
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6262
			return $tag;
6263
		}
6264
6265
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6266
			$href = $matches[1];
6267
			// Strip off query string
6268
			if ( $pos = strpos( $href, '?' ) ) {
6269
				$href = substr( $href, 0, $pos );
6270
			}
6271
			// Strip off fragment
6272
			if ( $pos = strpos( $href, '#' ) ) {
6273
				$href = substr( $href, 0, $pos );
6274
			}
6275
		} else {
6276
			return $tag;
6277
		}
6278
6279
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6280
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6281
			return $tag;
6282
		}
6283
6284
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6285
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6286
			// And this isn't the pass that actually deals with the RTL version...
6287
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6288
				// Short out, as the RTL version will deal with it in a moment.
6289
				return $tag;
6290
			}
6291
		}
6292
6293
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6294
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6295
		if ( $css ) {
6296
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6297
			if ( empty( $item->extra['after'] ) ) {
6298
				wp_add_inline_style( $handle, $css );
6299
			} else {
6300
				array_unshift( $item->extra['after'], $css );
6301
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6302
			}
6303
		}
6304
6305
		return $tag;
6306
	}
6307
6308
	/**
6309
	 * Loads a view file from the views
6310
	 *
6311
	 * Data passed in with the $data parameter will be available in the
6312
	 * template file as $data['value']
6313
	 *
6314
	 * @param string $template - Template file to load
6315
	 * @param array  $data - Any data to pass along to the template
6316
	 * @return boolean - If template file was found
6317
	 **/
6318
	public function load_view( $template, $data = array() ) {
6319
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6320
6321
		if ( file_exists( $views_dir . $template ) ) {
6322
			require_once $views_dir . $template;
6323
			return true;
6324
		}
6325
6326
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6327
		return false;
6328
	}
6329
6330
	/**
6331
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6332
	 */
6333
	public function deprecated_hooks() {
6334
		global $wp_filter;
6335
6336
		/*
6337
		 * Format:
6338
		 * deprecated_filter_name => replacement_name
6339
		 *
6340
		 * If there is no replacement, use null for replacement_name
6341
		 */
6342
		$deprecated_list = array(
6343
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6344
			'wpl_sharing_2014_1'                           => null,
6345
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6346
			'jetpack_identity_crisis_options_to_check'     => null,
6347
			'update_option_jetpack_single_user_site'       => null,
6348
			'audio_player_default_colors'                  => null,
6349
			'add_option_jetpack_featured_images_enabled'   => null,
6350
			'add_option_jetpack_update_details'            => null,
6351
			'add_option_jetpack_updates'                   => null,
6352
			'add_option_jetpack_network_name'              => null,
6353
			'add_option_jetpack_network_allow_new_registrations' => null,
6354
			'add_option_jetpack_network_add_new_users'     => null,
6355
			'add_option_jetpack_network_site_upload_space' => null,
6356
			'add_option_jetpack_network_upload_file_types' => null,
6357
			'add_option_jetpack_network_enable_administration_menus' => null,
6358
			'add_option_jetpack_is_multi_site'             => null,
6359
			'add_option_jetpack_is_main_network'           => null,
6360
			'add_option_jetpack_main_network_site'         => null,
6361
			'jetpack_sync_all_registered_options'          => null,
6362
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6363
			'jetpack_is_post_mailable'                     => null,
6364
			'jetpack_seo_site_host'                        => null,
6365
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6366
			'jetpack_holiday_snow_option_name'             => null,
6367
			'jetpack_holiday_chance_of_snow'               => null,
6368
			'jetpack_holiday_snow_js_url'                  => null,
6369
			'jetpack_is_holiday_snow_season'               => null,
6370
			'jetpack_holiday_snow_option_updated'          => null,
6371
			'jetpack_holiday_snowing'                      => null,
6372
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6373
			'jetpack_cache_plans'                          => null,
6374
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6375
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6376
			'jetpack_enable_site_verification'             => null,
6377
			'can_display_jetpack_manage_notice'            => null,
6378
			// Removed in Jetpack 7.3.0
6379
			'atd_load_scripts'                             => null,
6380
			'atd_http_post_timeout'                        => null,
6381
			'atd_http_post_error'                          => null,
6382
			'atd_service_domain'                           => null,
6383
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6384
			// Removed in Jetpack 7.9.0
6385
			'jetpack_pwa_manifest'                         => null,
6386
			'jetpack_pwa_background_color'                 => null,
6387
		);
6388
6389
		// This is a silly loop depth. Better way?
6390
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6391
			if ( has_action( $hook ) ) {
6392
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6393
					foreach ( $values as $hooked ) {
6394
						if ( is_callable( $hooked['function'] ) ) {
6395
							$function_name = 'an anonymous function';
6396
						} else {
6397
							$function_name = $hooked['function'];
6398
						}
6399
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6400
					}
6401
				}
6402
			}
6403
		}
6404
	}
6405
6406
	/**
6407
	 * Converts any url in a stylesheet, to the correct absolute url.
6408
	 *
6409
	 * Considerations:
6410
	 *  - Normal, relative URLs     `feh.png`
6411
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6412
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6413
	 *  - Absolute URLs             `http://domain.com/feh.png`
6414
	 *  - Domain root relative URLs `/feh.png`
6415
	 *
6416
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6417
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6418
	 *
6419
	 * @return mixed|string
6420
	 */
6421
	public static function absolutize_css_urls( $css, $css_file_url ) {
6422
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6423
		$css_dir = dirname( $css_file_url );
6424
		$p       = wp_parse_url( $css_dir );
6425
		$domain  = sprintf(
6426
			'%1$s//%2$s%3$s%4$s',
6427
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6428
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6429
			$p['host'],
6430
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6431
		);
6432
6433
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6434
			$find = $replace = array();
6435
			foreach ( $matches as $match ) {
6436
				$url = trim( $match['path'], "'\" \t" );
6437
6438
				// If this is a data url, we don't want to mess with it.
6439
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6440
					continue;
6441
				}
6442
6443
				// If this is an absolute or protocol-agnostic url,
6444
				// we don't want to mess with it.
6445
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6446
					continue;
6447
				}
6448
6449
				switch ( substr( $url, 0, 1 ) ) {
6450
					case '/':
6451
						$absolute = $domain . $url;
6452
						break;
6453
					default:
6454
						$absolute = $css_dir . '/' . $url;
6455
				}
6456
6457
				$find[]    = $match[0];
6458
				$replace[] = sprintf( 'url("%s")', $absolute );
6459
			}
6460
			$css = str_replace( $find, $replace, $css );
6461
		}
6462
6463
		return $css;
6464
	}
6465
6466
	/**
6467
	 * This methods removes all of the registered css files on the front end
6468
	 * from Jetpack in favor of using a single file. In effect "imploding"
6469
	 * all the files into one file.
6470
	 *
6471
	 * Pros:
6472
	 * - Uses only ONE css asset connection instead of 15
6473
	 * - Saves a minimum of 56k
6474
	 * - Reduces server load
6475
	 * - Reduces time to first painted byte
6476
	 *
6477
	 * Cons:
6478
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6479
	 *      should not cause any issues with themes.
6480
	 * - Plugins/themes dequeuing styles no longer do anything. See
6481
	 *      jetpack_implode_frontend_css filter for a workaround
6482
	 *
6483
	 * For some situations developers may wish to disable css imploding and
6484
	 * instead operate in legacy mode where each file loads seperately and
6485
	 * can be edited individually or dequeued. This can be accomplished with
6486
	 * the following line:
6487
	 *
6488
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6489
	 *
6490
	 * @since 3.2
6491
	 **/
6492
	public function implode_frontend_css( $travis_test = false ) {
6493
		$do_implode = true;
6494
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6495
			$do_implode = false;
6496
		}
6497
6498
		// Do not implode CSS when the page loads via the AMP plugin.
6499
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6500
			$do_implode = false;
6501
		}
6502
6503
		/**
6504
		 * Allow CSS to be concatenated into a single jetpack.css file.
6505
		 *
6506
		 * @since 3.2.0
6507
		 *
6508
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6509
		 */
6510
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6511
6512
		// Do not use the imploded file when default behavior was altered through the filter
6513
		if ( ! $do_implode ) {
6514
			return;
6515
		}
6516
6517
		// We do not want to use the imploded file in dev mode, or if not connected
6518
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6519
			if ( ! $travis_test ) {
6520
				return;
6521
			}
6522
		}
6523
6524
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6525
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6526
			return;
6527
		}
6528
6529
		/*
6530
		 * Now we assume Jetpack is connected and able to serve the single
6531
		 * file.
6532
		 *
6533
		 * In the future there will be a check here to serve the file locally
6534
		 * or potentially from the Jetpack CDN
6535
		 *
6536
		 * For now:
6537
		 * - Enqueue a single imploded css file
6538
		 * - Zero out the style_loader_tag for the bundled ones
6539
		 * - Be happy, drink scotch
6540
		 */
6541
6542
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6543
6544
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6545
6546
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6547
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6548
	}
6549
6550
	function concat_remove_style_loader_tag( $tag, $handle ) {
6551
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6552
			$tag = '';
6553
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6554
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6555
			}
6556
		}
6557
6558
		return $tag;
6559
	}
6560
6561
	/**
6562
	 * Add an async attribute to scripts that can be loaded asynchronously.
6563
	 * https://www.w3schools.com/tags/att_script_async.asp
6564
	 *
6565
	 * @since 7.7.0
6566
	 *
6567
	 * @param string $tag    The <script> tag for the enqueued script.
6568
	 * @param string $handle The script's registered handle.
6569
	 * @param string $src    The script's source URL.
6570
	 */
6571
	public function script_add_async( $tag, $handle, $src ) {
6572
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6573
			return preg_replace( '/^<script /i', '<script async ', $tag );
6574
		}
6575
6576
		return $tag;
6577
	}
6578
6579
	/*
6580
	 * Check the heartbeat data
6581
	 *
6582
	 * Organizes the heartbeat data by severity.  For example, if the site
6583
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6584
	 *
6585
	 * Data will be added to "caution" array, if it either:
6586
	 *  - Out of date Jetpack version
6587
	 *  - Out of date WP version
6588
	 *  - Out of date PHP version
6589
	 *
6590
	 * $return array $filtered_data
6591
	 */
6592
	public static function jetpack_check_heartbeat_data() {
6593
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6594
6595
		$good    = array();
6596
		$caution = array();
6597
		$bad     = array();
6598
6599
		foreach ( $raw_data as $stat => $value ) {
6600
6601
			// Check jetpack version
6602
			if ( 'version' == $stat ) {
6603
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6604
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6605
					continue;
6606
				}
6607
			}
6608
6609
			// Check WP version
6610
			if ( 'wp-version' == $stat ) {
6611
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6612
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6613
					continue;
6614
				}
6615
			}
6616
6617
			// Check PHP version
6618
			if ( 'php-version' == $stat ) {
6619
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6620
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_PHP_VERSION;
6621
					continue;
6622
				}
6623
			}
6624
6625
			// Check ID crisis
6626
			if ( 'identitycrisis' == $stat ) {
6627
				if ( 'yes' == $value ) {
6628
					$bad[ $stat ] = $value;
6629
					continue;
6630
				}
6631
			}
6632
6633
			// The rest are good :)
6634
			$good[ $stat ] = $value;
6635
		}
6636
6637
		$filtered_data = array(
6638
			'good'    => $good,
6639
			'caution' => $caution,
6640
			'bad'     => $bad,
6641
		);
6642
6643
		return $filtered_data;
6644
	}
6645
6646
6647
	/*
6648
	 * This method is used to organize all options that can be reset
6649
	 * without disconnecting Jetpack.
6650
	 *
6651
	 * It is used in class.jetpack-cli.php to reset options
6652
	 *
6653
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6654
	 *
6655
	 * @return array of options to delete.
6656
	 */
6657
	public static function get_jetpack_options_for_reset() {
6658
		return Jetpack_Options::get_options_for_reset();
6659
	}
6660
6661
	/*
6662
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6663
	 * so we can bring them directly to their site in calypso.
6664
	 *
6665
	 * @param string | url
6666
	 * @return string | url without the guff
6667
	 */
6668
	public static function build_raw_urls( $url ) {
6669
		$strip_http = '/.*?:\/\//i';
6670
		$url        = preg_replace( $strip_http, '', $url );
6671
		$url        = str_replace( '/', '::', $url );
6672
		return $url;
6673
	}
6674
6675
	/**
6676
	 * Stores and prints out domains to prefetch for page speed optimization.
6677
	 *
6678
	 * @param mixed $new_urls
6679
	 */
6680
	public static function dns_prefetch( $new_urls = null ) {
6681
		static $prefetch_urls = array();
6682
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6683
			echo "\r\n";
6684
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6685
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6686
			}
6687
		} elseif ( ! empty( $new_urls ) ) {
6688
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6689
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6690
			}
6691
			foreach ( (array) $new_urls as $this_new_url ) {
6692
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6693
			}
6694
			$prefetch_urls = array_unique( $prefetch_urls );
6695
		}
6696
	}
6697
6698
	public function wp_dashboard_setup() {
6699
		if ( self::is_active() ) {
6700
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6701
		}
6702
6703
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6704
			$jetpack_logo = new Jetpack_Logo();
6705
			$widget_title = sprintf(
6706
				wp_kses(
6707
					/* translators: Placeholder is a Jetpack logo. */
6708
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6709
					array( 'span' => array() )
6710
				),
6711
				$jetpack_logo->get_jp_emblem( true )
6712
			);
6713
6714
			wp_add_dashboard_widget(
6715
				'jetpack_summary_widget',
6716
				$widget_title,
6717
				array( __CLASS__, 'dashboard_widget' )
6718
			);
6719
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6720
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6721
6722
			// If we're inactive and not in development mode, sort our box to the top.
6723
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6724
				global $wp_meta_boxes;
6725
6726
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6727
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6728
6729
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6730
			}
6731
		}
6732
	}
6733
6734
	/**
6735
	 * @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...
6736
	 * @return mixed
6737
	 */
6738
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6739
		if ( ! is_array( $sorted ) ) {
6740
			return $sorted;
6741
		}
6742
6743
		foreach ( $sorted as $box_context => $ids ) {
6744
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6745
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6746
				continue;
6747
			}
6748
6749
			$ids_array = explode( ',', $ids );
6750
			$key       = array_search( 'dashboard_stats', $ids_array );
6751
6752
			if ( false !== $key ) {
6753
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6754
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6755
				$sorted[ $box_context ] = implode( ',', $ids_array );
6756
				// We've found it, stop searching, and just return.
6757
				break;
6758
			}
6759
		}
6760
6761
		return $sorted;
6762
	}
6763
6764
	public static function dashboard_widget() {
6765
		/**
6766
		 * Fires when the dashboard is loaded.
6767
		 *
6768
		 * @since 3.4.0
6769
		 */
6770
		do_action( 'jetpack_dashboard_widget' );
6771
	}
6772
6773
	public static function dashboard_widget_footer() {
6774
		?>
6775
		<footer>
6776
6777
		<div class="protect">
6778
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6779
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6780
				<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>
6781
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
6782
				<a href="
6783
				<?php
6784
				echo esc_url(
6785
					wp_nonce_url(
6786
						self::admin_url(
6787
							array(
6788
								'action' => 'activate',
6789
								'module' => 'protect',
6790
							)
6791
						),
6792
						'jetpack_activate-protect'
6793
					)
6794
				);
6795
				?>
6796
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6797
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6798
				</a>
6799
			<?php else : ?>
6800
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6801
			<?php endif; ?>
6802
		</div>
6803
6804
		<div class="akismet">
6805
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6806
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6807
				<p><?php echo esc_html_x( 'Spam comments blocked by Akismet.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6808
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6809
				<a href="
6810
				<?php
6811
				echo esc_url(
6812
					wp_nonce_url(
6813
						add_query_arg(
6814
							array(
6815
								'action' => 'activate',
6816
								'plugin' => 'akismet/akismet.php',
6817
							),
6818
							admin_url( 'plugins.php' )
6819
						),
6820
						'activate-plugin_akismet/akismet.php'
6821
					)
6822
				);
6823
				?>
6824
							" class="button button-jetpack">
6825
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6826
				</a>
6827
			<?php else : ?>
6828
				<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( 'Akismet can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
6829
			<?php endif; ?>
6830
		</div>
6831
6832
		</footer>
6833
		<?php
6834
	}
6835
6836
	/*
6837
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6838
	 */
6839
	function jetpack_icon_user_connected( $columns ) {
6840
		$columns['user_jetpack'] = '';
6841
		return $columns;
6842
	}
6843
6844
	/*
6845
	 * Show Jetpack icon if the user is linked.
6846
	 */
6847
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6848
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
6849
			$jetpack_logo = new Jetpack_Logo();
6850
			$emblem_html  = sprintf(
6851
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6852
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6853
				$jetpack_logo->get_jp_emblem()
6854
			);
6855
			return $emblem_html;
6856
		}
6857
6858
		return $val;
6859
	}
6860
6861
	/*
6862
	 * Style the Jetpack user column
6863
	 */
6864
	function jetpack_user_col_style() {
6865
		global $current_screen;
6866
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
6867
			?>
6868
			<style>
6869
				.fixed .column-user_jetpack {
6870
					width: 21px;
6871
				}
6872
				.jp-emblem-user-admin svg {
6873
					width: 20px;
6874
					height: 20px;
6875
				}
6876
				.jp-emblem-user-admin path {
6877
					fill: #00BE28;
6878
				}
6879
			</style>
6880
			<?php
6881
		}
6882
	}
6883
6884
	/**
6885
	 * Checks if Akismet is active and working.
6886
	 *
6887
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6888
	 * that implied usage of methods present since more recent version.
6889
	 * See https://github.com/Automattic/jetpack/pull/9585
6890
	 *
6891
	 * @since  5.1.0
6892
	 *
6893
	 * @return bool True = Akismet available. False = Aksimet not available.
6894
	 */
6895
	public static function is_akismet_active() {
6896
		static $status = null;
6897
6898
		if ( ! is_null( $status ) ) {
6899
			return $status;
6900
		}
6901
6902
		// Check if a modern version of Akismet is active.
6903
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6904
			$status = false;
6905
			return $status;
6906
		}
6907
6908
		// Make sure there is a key known to Akismet at all before verifying key.
6909
		$akismet_key = Akismet::get_api_key();
6910
		if ( ! $akismet_key ) {
6911
			$status = false;
6912
			return $status;
6913
		}
6914
6915
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6916
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6917
6918
		// 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.
6919
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6920
		// We cache the result of the Akismet key verification for ten minutes.
6921
		if ( ! $akismet_key_state || $recheck ) {
6922
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6923
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6924
		}
6925
6926
		$status = 'valid' === $akismet_key_state;
6927
6928
		return $status;
6929
	}
6930
6931
	/**
6932
	 * @deprecated
6933
	 *
6934
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
6935
	 */
6936
	public static function is_function_in_backtrace() {
6937
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
6938
	}
6939
6940
	/**
6941
	 * Given a minified path, and a non-minified path, will return
6942
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6943
	 *
6944
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6945
	 * root Jetpack directory.
6946
	 *
6947
	 * @since 5.6.0
6948
	 *
6949
	 * @param string $min_path
6950
	 * @param string $non_min_path
6951
	 * @return string The URL to the file
6952
	 */
6953
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6954
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
6955
	}
6956
6957
	/**
6958
	 * Checks for whether Jetpack Backup & Scan is enabled.
6959
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
6960
	 *
6961
	 * @return bool|int|mixed
6962
	 */
6963
	public static function is_rewind_enabled() {
6964
		if ( ! self::is_active() ) {
6965
			return false;
6966
		}
6967
6968
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6969
		if ( false === $rewind_enabled ) {
6970
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6971
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6972
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
6973
				&& ! empty( $rewind_data['state'] )
6974
				&& 'active' === $rewind_data['state'] )
6975
				? 1
6976
				: 0;
6977
6978
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
6979
		}
6980
		return $rewind_enabled;
6981
	}
6982
6983
	/**
6984
	 * Return Calypso environment value; used for developing Jetpack and pairing
6985
	 * it with different Calypso enrionments, such as localhost.
6986
	 *
6987
	 * @since 7.4.0
6988
	 *
6989
	 * @return string Calypso environment
6990
	 */
6991
	public static function get_calypso_env() {
6992
		if ( isset( $_GET['calypso_env'] ) ) {
6993
			return sanitize_key( $_GET['calypso_env'] );
6994
		}
6995
6996
		if ( getenv( 'CALYPSO_ENV' ) ) {
6997
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
6998
		}
6999
7000
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7001
			return sanitize_key( CALYPSO_ENV );
7002
		}
7003
7004
		return '';
7005
	}
7006
7007
	/**
7008
	 * Checks whether or not TOS has been agreed upon.
7009
	 * Will return true if a user has clicked to register, or is already connected.
7010
	 */
7011
	public static function jetpack_tos_agreed() {
7012
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7013
7014
		$terms_of_service = new Terms_Of_Service();
7015
		return $terms_of_service->has_agreed();
7016
7017
	}
7018
7019
	/**
7020
	 * Handles activating default modules as well general cleanup for the new connection.
7021
	 *
7022
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7023
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7024
	 * @param boolean $send_state_messages          Whether to send state messages.
7025
	 * @return void
7026
	 */
7027
	public static function handle_post_authorization_actions(
7028
		$activate_sso = false,
7029
		$redirect_on_activation_error = false,
7030
		$send_state_messages = true
7031
	) {
7032
		$other_modules = $activate_sso
7033
			? array( 'sso' )
7034
			: array();
7035
7036
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7037
			self::delete_active_modules();
7038
7039
			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...
7040
		} else {
7041
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7042
		}
7043
7044
		// Since this is a fresh connection, be sure to clear out IDC options
7045
		Jetpack_IDC::clear_all_idc_options();
7046
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7047
7048
		// Start nonce cleaner
7049
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7050
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7051
7052
		if ( $send_state_messages ) {
7053
			self::state( 'message', 'authorized' );
7054
		}
7055
	}
7056
7057
	/**
7058
	 * Returns a boolean for whether backups UI should be displayed or not.
7059
	 *
7060
	 * @return bool Should backups UI be displayed?
7061
	 */
7062
	public static function show_backups_ui() {
7063
		/**
7064
		 * Whether UI for backups should be displayed.
7065
		 *
7066
		 * @since 6.5.0
7067
		 *
7068
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7069
		 */
7070
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7071
	}
7072
7073
	/*
7074
	 * Deprecated manage functions
7075
	 */
7076
	function prepare_manage_jetpack_notice() {
7077
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7078
	}
7079
	function manage_activate_screen() {
7080
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7081
	}
7082
	function admin_jetpack_manage_notice() {
7083
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7084
	}
7085
	function opt_out_jetpack_manage_url() {
7086
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7087
	}
7088
	function opt_in_jetpack_manage_url() {
7089
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7090
	}
7091
	function opt_in_jetpack_manage_notice() {
7092
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7093
	}
7094
	function can_display_jetpack_manage_notice() {
7095
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7096
	}
7097
7098
	/**
7099
	 * Clean leftoveruser meta.
7100
	 *
7101
	 * Delete Jetpack-related user meta when it is no longer needed.
7102
	 *
7103
	 * @since 7.3.0
7104
	 *
7105
	 * @param int $user_id User ID being updated.
7106
	 */
7107
	public static function user_meta_cleanup( $user_id ) {
7108
		$meta_keys = array(
7109
			// AtD removed from Jetpack 7.3
7110
			'AtD_options',
7111
			'AtD_check_when',
7112
			'AtD_guess_lang',
7113
			'AtD_ignored_phrases',
7114
		);
7115
7116
		foreach ( $meta_keys as $meta_key ) {
7117
			if ( get_user_meta( $user_id, $meta_key ) ) {
7118
				delete_user_meta( $user_id, $meta_key );
7119
			}
7120
		}
7121
	}
7122
7123
	/**
7124
	 * Checks if a Jetpack site is both active and not in development.
7125
	 *
7126
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7127
	 *
7128
	 * @return bool True if Jetpack is active and not in development.
7129
	 */
7130
	public static function is_active_and_not_development_mode() {
7131
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7132
			return false;
7133
		}
7134
		return true;
7135
	}
7136
}
7137