Completed
Push — add/deterministic-init ( 8891ab...704001 )
by
unknown
06:45
created

class.jetpack.php (64 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

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
399
			self::$instance->plugin_upgrade();
400
		}
401
402
		return self::$instance;
403
	}
404
405
	/**
406
	 * Must never be called statically
407
	 */
408
	function plugin_upgrade() {
409
		if ( self::is_active() ) {
410
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
411
			if ( JETPACK__VERSION != $version ) {
412
				// Prevent multiple upgrades at once - only a single process should trigger
413
				// an upgrade to avoid stampedes
414
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
415
					return;
416
				}
417
418
				// Set a short lock to prevent multiple instances of the upgrade
419
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
420
421
				// check which active modules actually exist and remove others from active_modules list
422
				$unfiltered_modules = self::get_active_modules();
423
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
424
				if ( array_diff( $unfiltered_modules, $modules ) ) {
425
					self::update_active_modules( $modules );
426
				}
427
428
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
429
430
				// Upgrade to 4.3.0
431
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
432
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
433
				}
434
435
				// Make sure Markdown for posts gets turned back on
436
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
437
					update_option( 'wpcom_publish_posts_with_markdown', true );
438
				}
439
440
				if ( did_action( 'wp_loaded' ) ) {
441
					self::upgrade_on_load();
442
				} else {
443
					add_action(
444
						'wp_loaded',
445
						array( __CLASS__, 'upgrade_on_load' )
446
					);
447
				}
448
			}
449
		}
450
	}
451
452
	/**
453
	 * Runs upgrade routines that need to have modules loaded.
454
	 */
455
	static function upgrade_on_load() {
456
457
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
458
		// This can happen in case Jetpack has been just upgraded and is
459
		// being initialized late during the page load. In this case we wait
460
		// until the next proper admin page load with Jetpack active.
461
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
462
			delete_transient( self::$plugin_upgrade_lock_key );
463
464
			return;
465
		}
466
467
		self::maybe_set_version_option();
468
469
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
470
			Jetpack_Widget_Conditions::migrate_post_type_rules();
471
		}
472
473
		if (
474
			class_exists( 'Jetpack_Sitemap_Manager' )
475
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
476
		) {
477
			do_action( 'jetpack_sitemaps_purge_data' );
478
		}
479
480
		// Delete old stats cache
481
		delete_option( 'jetpack_restapi_stats_cache' );
482
483
		delete_transient( self::$plugin_upgrade_lock_key );
484
	}
485
486
	/**
487
	 * Saves all the currently active modules to options.
488
	 * Also fires Action hooks for each newly activated and deactivated module.
489
	 *
490
	 * @param $modules Array Array of active modules to be saved in options.
491
	 *
492
	 * @return $success bool true for success, false for failure.
0 ignored issues
show
The doc-type $success could not be parsed: Unknown type name "$success" at position 0. (view supported doc-types)

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

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