Completed
Push — fix/manager_api_version ( cc83d0...890261 )
by
unknown
07:11
created

Jetpack::configure()   C

Complexity

Conditions 10
Paths 96

Size

Total Lines 72

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 10
nc 96
nop 0
dl 0
loc 72
rs 6.7442
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

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

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

Commonly applied refactorings include:

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