Completed
Push — dna/fix-wpcom-fatal ( a948da...ae1bff )
by
unknown
07:16
created

Jetpack::plugin_textdomain()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 0
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
<?php
2
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
Documentation introduced by
The doc-type $success could not be parsed: Unknown type name "$success" at position 0. (view supported doc-types)

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

Loading history...
493
	 */
494
	static function update_active_modules( $modules ) {
495
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
496
		$active_modules       = self::get_active_modules();
497
		$new_active_modules   = array_diff( $modules, $current_modules );
498
		$new_inactive_modules = array_diff( $active_modules, $modules );
499
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
500
		$reindexed_modules    = array_values( $new_current_modules );
501
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
502
503
		foreach ( $new_active_modules as $module ) {
504
			/**
505
			 * Fires when a specific module is activated.
506
			 *
507
			 * @since 1.9.0
508
			 *
509
			 * @param string $module Module slug.
510
			 * @param boolean $success whether the module was activated. @since 4.2
511
			 */
512
			do_action( 'jetpack_activate_module', $module, $success );
513
			/**
514
			 * Fires when a module is activated.
515
			 * The dynamic part of the filter, $module, is the module slug.
516
			 *
517
			 * @since 1.9.0
518
			 *
519
			 * @param string $module Module slug.
520
			 */
521
			do_action( "jetpack_activate_module_$module", $module );
522
		}
523
524
		foreach ( $new_inactive_modules as $module ) {
525
			/**
526
			 * Fired after a module has been deactivated.
527
			 *
528
			 * @since 4.2.0
529
			 *
530
			 * @param string $module Module slug.
531
			 * @param boolean $success whether the module was deactivated.
532
			 */
533
			do_action( 'jetpack_deactivate_module', $module, $success );
534
			/**
535
			 * Fires when a module is deactivated.
536
			 * The dynamic part of the filter, $module, is the module slug.
537
			 *
538
			 * @since 1.9.0
539
			 *
540
			 * @param string $module Module slug.
541
			 */
542
			do_action( "jetpack_deactivate_module_$module", $module );
543
		}
544
545
		return $success;
546
	}
547
548
	static function delete_active_modules() {
549
		self::update_active_modules( array() );
550
	}
551
552
	/**
553
	 * Constructor.  Initializes WordPress hooks
554
	 */
555
	private function __construct() {
556
		/*
557
		 * Check for and alert any deprecated hooks
558
		 */
559
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
560
561
		add_action( 'plugins_loaded', array( __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
645
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
646
647
		/**
648
		 * These actions run checks to load additional files.
649
		 * They check for external files or plugins, so they need to run as late as possible.
650
		 */
651
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
652
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
653
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
654
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
655
656
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
657
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
658
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
659
660
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
661
662
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
663
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
664
665
		// A filter to control all just in time messages
666
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
667
668
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
669
670
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
671
		// We should make sure to only do this for front end links.
672
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
673
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
674
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
675
676
			// we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
677
			// so they point moderation links on emails to Calypso
678
			jetpack_require_lib( 'functions.wp-notify' );
679
		}
680
681
		// Hide edit post link if mobile app.
682
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
683
			add_filter( 'edit_post_link', '__return_empty_string' );
684
		}
685
686
		// Update the Jetpack plan from API on heartbeats
687
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
688
689
		/**
690
		 * This is the hack to concatenate all css files into one.
691
		 * For description and reasoning see the implode_frontend_css method
692
		 *
693
		 * Super late priority so we catch all the registered styles
694
		 */
695
		if ( ! is_admin() ) {
696
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
697
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
698
		}
699
700
		/**
701
		 * These are sync actions that we need to keep track of for jitms
702
		 */
703
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
704
705
		// Actually push the stats on shutdown.
706
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
707
			add_action( 'shutdown', array( $this, 'push_stats' ) );
708
		}
709
710
		/*
711
		 * Load some scripts asynchronously.
712
		 */
713
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
714
715
		// Actions for Manager::authorize().
716
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
717
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
718
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
719
720
		// Filters for the Manager::get_token() urls and request body.
721
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
722
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
723
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
724
	}
725
726
	/**
727
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
728
	 * Config object.
729
	 */
730
	public static function configure() {
731
		$config = new Config();
732
733
		foreach (
734
			array(
735
				'sync',
736
				'tracking',
737
				'tos',
738
			)
739
			as $feature
740
		) {
741
			$config->ensure( $feature );
742
		}
743
744
		/*
745
		 * Enable enhanced handling of previewing sites in Calypso
746
		 */
747
		if ( self::is_active() ) {
748
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
749
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
750
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
751
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
752
		}
753
754
	}
755
756
	/**
757
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
758
	 * initialization code.
759
	 *
760
	 * @action plugins_loaded
761
	 */
762
	public function late_initialization() {
763
		self::plugin_textdomain();
764
		self::load_modules();
765
766
		Partner::init();
767
768
		/**
769
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
770
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
771
		 *
772
		 * @since 8.1.0
773
		 *
774
		 * @param Jetpack $jetpack the main plugin class object.
775
		 */
776
		do_action( 'jetpack_loaded', $this );
777
778
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
779
	}
780
781
	/**
782
	 * Sets up the XMLRPC request handlers.
783
	 *
784
	 * @deprecated since 7.7.0
785
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
786
	 *
787
	 * @param Array                 $request_params Incoming request parameters.
788
	 * @param Boolean               $is_active      Whether the connection is currently active.
789
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
790
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $xmlrpc_server not be null|Jetpack_XMLRPC_Server?

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

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

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

Loading history...
791
	 */
792
	public function setup_xmlrpc_handlers(
793
		$request_params,
794
		$is_active,
795
		$is_signed,
796
		Jetpack_XMLRPC_Server $xmlrpc_server = null
797
	) {
798
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
799
		return $this->connection_manager->setup_xmlrpc_handlers(
800
			$request_params,
801
			$is_active,
802
			$is_signed,
803
			$xmlrpc_server
804
		);
805
	}
806
807
	/**
808
	 * Initialize REST API registration connector.
809
	 *
810
	 * @deprecated since 7.7.0
811
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
812
	 */
813
	public function initialize_rest_api_registration_connector() {
814
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
815
		$this->connection_manager->initialize_rest_api_registration_connector();
816
	}
817
818
	/**
819
	 * This is ported over from the manage module, which has been deprecated and baked in here.
820
	 *
821
	 * @param $domains
822
	 */
823
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
824
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
825
	}
826
827
	/**
828
	 * Return $domains, with 'wordpress.com' appended.
829
	 * This is ported over from the manage module, which has been deprecated and baked in here.
830
	 *
831
	 * @param $domains
832
	 * @return array
833
	 */
834
	function allow_wpcom_domain( $domains ) {
835
		if ( empty( $domains ) ) {
836
			$domains = array();
837
		}
838
		$domains[] = 'wordpress.com';
839
		return array_unique( $domains );
840
	}
841
842
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
843
		$post = get_post( $post_id );
844
845
		if ( empty( $post ) ) {
846
			return $default_url;
847
		}
848
849
		$post_type = $post->post_type;
850
851
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
852
		// https://en.support.wordpress.com/custom-post-types/
853
		$allowed_post_types = array(
854
			'post'                => 'post',
855
			'page'                => 'page',
856
			'jetpack-portfolio'   => 'edit/jetpack-portfolio',
857
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
858
		);
859
860
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
861
			return $default_url;
862
		}
863
864
		$path_prefix = $allowed_post_types[ $post_type ];
865
866
		$site_slug = self::build_raw_urls( get_home_url() );
867
868
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
869
	}
870
871
	function point_edit_comment_links_to_calypso( $url ) {
872
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
873
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

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

Loading history...
874
		return esc_url(
875
			sprintf(
876
				'https://wordpress.com/comment/%s/%d',
877
				self::build_raw_urls( get_home_url() ),
878
				$query_args['amp;c']
879
			)
880
		);
881
	}
882
883
	function jetpack_track_last_sync_callback( $params ) {
884
		/**
885
		 * Filter to turn off jitm caching
886
		 *
887
		 * @since 5.4.0
888
		 *
889
		 * @param bool false Whether to cache just in time messages
890
		 */
891
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
892
			return $params;
893
		}
894
895
		if ( is_array( $params ) && isset( $params[0] ) ) {
896
			$option = $params[0];
897
			if ( 'active_plugins' === $option ) {
898
				// use the cache if we can, but not terribly important if it gets evicted
899
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
900
			}
901
		}
902
903
		return $params;
904
	}
905
906
	function jetpack_connection_banner_callback() {
907
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
908
909
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
910
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
911
			wp_send_json_success();
912
		}
913
914
		wp_die();
915
	}
916
917
	/**
918
	 * Removes all XML-RPC methods that are not `jetpack.*`.
919
	 * Only used in our alternate XML-RPC endpoint, where we want to
920
	 * ensure that Core and other plugins' methods are not exposed.
921
	 *
922
	 * @deprecated since 7.7.0
923
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
924
	 *
925
	 * @param array $methods A list of registered WordPress XMLRPC methods.
926
	 * @return array Filtered $methods
927
	 */
928
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
929
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
930
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
931
	}
932
933
	/**
934
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
935
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
936
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
937
	 * which is accessible via a different URI. Most of the below is copied directly
938
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
939
	 *
940
	 * @deprecated since 7.7.0
941
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
942
	 */
943
	public function alternate_xmlrpc() {
944
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
945
		$this->connection_manager->alternate_xmlrpc();
946
	}
947
948
	/**
949
	 * The callback for the JITM ajax requests.
950
	 *
951
	 * @deprecated since 7.9.0
952
	 */
953
	function jetpack_jitm_ajax_callback() {
954
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
955
	}
956
957
	/**
958
	 * If there are any stats that need to be pushed, but haven't been, push them now.
959
	 */
960
	function push_stats() {
961
		if ( ! empty( $this->stats ) ) {
962
			$this->do_stats( 'server_side' );
963
		}
964
	}
965
966
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
967
		$is_development_mode = ( new Status() )->is_development_mode();
968
		switch ( $cap ) {
969
			case 'jetpack_connect':
970
			case 'jetpack_reconnect':
971
				if ( $is_development_mode ) {
972
					$caps = array( 'do_not_allow' );
973
					break;
974
				}
975
				/**
976
				 * Pass through. If it's not development mode, these should match disconnect.
977
				 * Let users disconnect if it's development mode, just in case things glitch.
978
				 */
979
			case 'jetpack_disconnect':
980
				/**
981
				 * In multisite, can individual site admins manage their own connection?
982
				 *
983
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
984
				 */
985
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
986
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
987
						/**
988
						 * We need to update the option name -- it's terribly unclear which
989
						 * direction the override goes.
990
						 *
991
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
992
						 */
993
						$caps = array( 'do_not_allow' );
994
						break;
995
					}
996
				}
997
998
				$caps = array( 'manage_options' );
999
				break;
1000
			case 'jetpack_manage_modules':
1001
			case 'jetpack_activate_modules':
1002
			case 'jetpack_deactivate_modules':
1003
				$caps = array( 'manage_options' );
1004
				break;
1005
			case 'jetpack_configure_modules':
1006
				$caps = array( 'manage_options' );
1007
				break;
1008
			case 'jetpack_manage_autoupdates':
1009
				$caps = array(
1010
					'manage_options',
1011
					'update_plugins',
1012
				);
1013
				break;
1014
			case 'jetpack_network_admin_page':
1015
			case 'jetpack_network_settings_page':
1016
				$caps = array( 'manage_network_plugins' );
1017
				break;
1018
			case 'jetpack_network_sites_page':
1019
				$caps = array( 'manage_sites' );
1020
				break;
1021
			case 'jetpack_admin_page':
1022
				if ( $is_development_mode ) {
1023
					$caps = array( 'manage_options' );
1024
					break;
1025
				} else {
1026
					$caps = array( 'read' );
1027
				}
1028
				break;
1029
			case 'jetpack_connect_user':
1030
				if ( $is_development_mode ) {
1031
					$caps = array( 'do_not_allow' );
1032
					break;
1033
				}
1034
				$caps = array( 'read' );
1035
				break;
1036
		}
1037
		return $caps;
1038
	}
1039
1040
	/**
1041
	 * Require a Jetpack authentication.
1042
	 *
1043
	 * @deprecated since 7.7.0
1044
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1045
	 */
1046
	public function require_jetpack_authentication() {
1047
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1048
		$this->connection_manager->require_jetpack_authentication();
1049
	}
1050
1051
	/**
1052
	 * Load language files
1053
	 *
1054
	 * @action plugins_loaded
1055
	 */
1056
	public static function plugin_textdomain() {
1057
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1058
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1059
	}
1060
1061
	/**
1062
	 * Register assets for use in various modules and the Jetpack admin page.
1063
	 *
1064
	 * @uses wp_script_is, wp_register_script, plugins_url
1065
	 * @action wp_loaded
1066
	 * @return null
1067
	 */
1068
	public function register_assets() {
1069
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1070
			wp_register_script(
1071
				'spin',
1072
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1073
				false,
1074
				'1.3'
1075
			);
1076
		}
1077
1078 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1079
			wp_register_script(
1080
				'jquery.spin',
1081
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1082
				array( 'jquery', 'spin' ),
1083
				'1.3'
1084
			);
1085
		}
1086
1087 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1088
			wp_register_script(
1089
				'jetpack-gallery-settings',
1090
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1091
				array( 'media-views' ),
1092
				'20121225'
1093
			);
1094
		}
1095
1096 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1097
			wp_register_script(
1098
				'jetpack-twitter-timeline',
1099
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1100
				array( 'jquery' ),
1101
				'4.0.0',
1102
				true
1103
			);
1104
		}
1105
1106
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1107
			wp_register_script(
1108
				'jetpack-facebook-embed',
1109
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1110
				array( 'jquery' ),
1111
				null,
1112
				true
1113
			);
1114
1115
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1116
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1117
			if ( ! is_numeric( $fb_app_id ) ) {
1118
				$fb_app_id = '';
1119
			}
1120
			wp_localize_script(
1121
				'jetpack-facebook-embed',
1122
				'jpfbembed',
1123
				array(
1124
					'appid'  => $fb_app_id,
1125
					'locale' => $this->get_locale(),
1126
				)
1127
			);
1128
		}
1129
1130
		/**
1131
		 * As jetpack_register_genericons is by default fired off a hook,
1132
		 * the hook may have already fired by this point.
1133
		 * So, let's just trigger it manually.
1134
		 */
1135
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1136
		jetpack_register_genericons();
1137
1138
		/**
1139
		 * Register the social logos
1140
		 */
1141
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1142
		jetpack_register_social_logos();
1143
1144 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1145
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1146
		}
1147
	}
1148
1149
	/**
1150
	 * Guess locale from language code.
1151
	 *
1152
	 * @param string $lang Language code.
1153
	 * @return string|bool
1154
	 */
1155 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1156
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1157
			return 'en_US';
1158
		}
1159
1160
		if ( ! class_exists( 'GP_Locales' ) ) {
1161
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1162
				return false;
1163
			}
1164
1165
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1166
		}
1167
1168
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1169
			// WP.com: get_locale() returns 'it'
1170
			$locale = GP_Locales::by_slug( $lang );
1171
		} else {
1172
			// Jetpack: get_locale() returns 'it_IT';
1173
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1174
		}
1175
1176
		if ( ! $locale ) {
1177
			return false;
1178
		}
1179
1180
		if ( empty( $locale->facebook_locale ) ) {
1181
			if ( empty( $locale->wp_locale ) ) {
1182
				return false;
1183
			} else {
1184
				// Facebook SDK is smart enough to fall back to en_US if a
1185
				// locale isn't supported. Since supported Facebook locales
1186
				// can fall out of sync, we'll attempt to use the known
1187
				// wp_locale value and rely on said fallback.
1188
				return $locale->wp_locale;
1189
			}
1190
		}
1191
1192
		return $locale->facebook_locale;
1193
	}
1194
1195
	/**
1196
	 * Get the locale.
1197
	 *
1198
	 * @return string|bool
1199
	 */
1200
	function get_locale() {
1201
		$locale = $this->guess_locale_from_lang( get_locale() );
1202
1203
		if ( ! $locale ) {
1204
			$locale = 'en_US';
1205
		}
1206
1207
		return $locale;
1208
	}
1209
1210
	/**
1211
	 * Return the network_site_url so that .com knows what network this site is a part of.
1212
	 *
1213
	 * @param  bool $option
1214
	 * @return string
1215
	 */
1216
	public function jetpack_main_network_site_option( $option ) {
1217
		return network_site_url();
1218
	}
1219
	/**
1220
	 * Network Name.
1221
	 */
1222
	static function network_name( $option = null ) {
1223
		global $current_site;
1224
		return $current_site->site_name;
1225
	}
1226
	/**
1227
	 * Does the network allow new user and site registrations.
1228
	 *
1229
	 * @return string
1230
	 */
1231
	static function network_allow_new_registrations( $option = null ) {
1232
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1233
	}
1234
	/**
1235
	 * Does the network allow admins to add new users.
1236
	 *
1237
	 * @return boolian
1238
	 */
1239
	static function network_add_new_users( $option = null ) {
1240
		return (bool) get_site_option( 'add_new_users' );
1241
	}
1242
	/**
1243
	 * File upload psace left per site in MB.
1244
	 *  -1 means NO LIMIT.
1245
	 *
1246
	 * @return number
1247
	 */
1248
	static function network_site_upload_space( $option = null ) {
1249
		// value in MB
1250
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1251
	}
1252
1253
	/**
1254
	 * Network allowed file types.
1255
	 *
1256
	 * @return string
1257
	 */
1258
	static function network_upload_file_types( $option = null ) {
1259
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1260
	}
1261
1262
	/**
1263
	 * Maximum file upload size set by the network.
1264
	 *
1265
	 * @return number
1266
	 */
1267
	static function network_max_upload_file_size( $option = null ) {
1268
		// value in KB
1269
		return get_site_option( 'fileupload_maxk', 300 );
1270
	}
1271
1272
	/**
1273
	 * Lets us know if a site allows admins to manage the network.
1274
	 *
1275
	 * @return array
1276
	 */
1277
	static function network_enable_administration_menus( $option = null ) {
1278
		return get_site_option( 'menu_items' );
1279
	}
1280
1281
	/**
1282
	 * If a user has been promoted to or demoted from admin, we need to clear the
1283
	 * jetpack_other_linked_admins transient.
1284
	 *
1285
	 * @since 4.3.2
1286
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1287
	 *
1288
	 * @param int    $user_id   The user ID whose role changed.
1289
	 * @param string $role      The new role.
1290
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $old_roles not be array|null?

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

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

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

Loading history...
1291
	 */
1292
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1293
		if ( 'administrator' == $role
1294
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1295
			|| is_null( $old_roles )
1296
		) {
1297
			delete_transient( 'jetpack_other_linked_admins' );
1298
		}
1299
	}
1300
1301
	/**
1302
	 * Checks to see if there are any other users available to become primary
1303
	 * Users must both:
1304
	 * - Be linked to wpcom
1305
	 * - Be an admin
1306
	 *
1307
	 * @return mixed False if no other users are linked, Int if there are.
1308
	 */
1309
	static function get_other_linked_admins() {
1310
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1311
1312
		if ( false === $other_linked_users ) {
1313
			$admins = get_users( array( 'role' => 'administrator' ) );
1314
			if ( count( $admins ) > 1 ) {
1315
				$available = array();
1316
				foreach ( $admins as $admin ) {
1317
					if ( self::is_user_connected( $admin->ID ) ) {
1318
						$available[] = $admin->ID;
1319
					}
1320
				}
1321
1322
				$count_connected_admins = count( $available );
1323
				if ( count( $available ) > 1 ) {
1324
					$other_linked_users = $count_connected_admins;
1325
				} else {
1326
					$other_linked_users = 0;
1327
				}
1328
			} else {
1329
				$other_linked_users = 0;
1330
			}
1331
1332
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1333
		}
1334
1335
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1336
	}
1337
1338
	/**
1339
	 * Return whether we are dealing with a multi network setup or not.
1340
	 * The reason we are type casting this is because we want to avoid the situation where
1341
	 * the result is false since when is_main_network_option return false it cases
1342
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1343
	 * database which could be set to anything as opposed to what this function returns.
1344
	 *
1345
	 * @param  bool $option
1346
	 *
1347
	 * @return boolean
1348
	 */
1349
	public function is_main_network_option( $option ) {
1350
		// return '1' or ''
1351
		return (string) (bool) self::is_multi_network();
1352
	}
1353
1354
	/**
1355
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1356
	 *
1357
	 * @param  string $option
1358
	 * @return boolean
1359
	 */
1360
	public function is_multisite( $option ) {
1361
		return (string) (bool) is_multisite();
1362
	}
1363
1364
	/**
1365
	 * Implemented since there is no core is multi network function
1366
	 * Right now there is no way to tell if we which network is the dominant network on the system
1367
	 *
1368
	 * @since  3.3
1369
	 * @return boolean
1370
	 */
1371 View Code Duplication
	public static function is_multi_network() {
1372
		global  $wpdb;
1373
1374
		// if we don't have a multi site setup no need to do any more
1375
		if ( ! is_multisite() ) {
1376
			return false;
1377
		}
1378
1379
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1380
		if ( $num_sites > 1 ) {
1381
			return true;
1382
		} else {
1383
			return false;
1384
		}
1385
	}
1386
1387
	/**
1388
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1389
	 *
1390
	 * @return null
1391
	 */
1392
	function update_jetpack_main_network_site_option() {
1393
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1394
	}
1395
	/**
1396
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1397
	 */
1398
	function update_jetpack_network_settings() {
1399
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1400
		// Only sync this info for the main network site.
1401
	}
1402
1403
	/**
1404
	 * Get back if the current site is single user site.
1405
	 *
1406
	 * @return bool
1407
	 */
1408 View Code Duplication
	public static function is_single_user_site() {
1409
		global $wpdb;
1410
1411
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1412
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1413
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1414
		}
1415
		return 1 === (int) $some_users;
1416
	}
1417
1418
	/**
1419
	 * Returns true if the site has file write access false otherwise.
1420
	 *
1421
	 * @return string ( '1' | '0' )
1422
	 **/
1423
	public static function file_system_write_access() {
1424
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1425
			require_once ABSPATH . 'wp-admin/includes/file.php';
1426
		}
1427
1428
		require_once ABSPATH . 'wp-admin/includes/template.php';
1429
1430
		$filesystem_method = get_filesystem_method();
1431
		if ( $filesystem_method === 'direct' ) {
1432
			return 1;
1433
		}
1434
1435
		ob_start();
1436
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1437
		ob_end_clean();
1438
		if ( $filesystem_credentials_are_stored ) {
1439
			return 1;
1440
		}
1441
		return 0;
1442
	}
1443
1444
	/**
1445
	 * Finds out if a site is using a version control system.
1446
	 *
1447
	 * @return string ( '1' | '0' )
1448
	 **/
1449
	public static function is_version_controlled() {
1450
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1451
		return (string) (int) Functions::is_version_controlled();
1452
	}
1453
1454
	/**
1455
	 * Determines whether the current theme supports featured images or not.
1456
	 *
1457
	 * @return string ( '1' | '0' )
1458
	 */
1459
	public static function featured_images_enabled() {
1460
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1461
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1462
	}
1463
1464
	/**
1465
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1466
	 *
1467
	 * @deprecated 4.7 use get_avatar_url instead.
1468
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1469
	 * @param int               $size Size of the avatar image
1470
	 * @param string            $default URL to a default image to use if no avatar is available
1471
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1472
	 *
1473
	 * @return array
1474
	 */
1475
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1476
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1477
		return get_avatar_url(
1478
			$id_or_email,
1479
			array(
1480
				'size'          => $size,
1481
				'default'       => $default,
1482
				'force_default' => $force_display,
1483
			)
1484
		);
1485
	}
1486
1487
	/**
1488
	 * jetpack_updates is saved in the following schema:
1489
	 *
1490
	 * array (
1491
	 *      'plugins'                       => (int) Number of plugin updates available.
1492
	 *      'themes'                        => (int) Number of theme updates available.
1493
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1494
	 *      'translations'                  => (int) Number of translation updates available.
1495
	 *      'total'                         => (int) Total of all available updates.
1496
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1497
	 * )
1498
	 *
1499
	 * @return array
1500
	 */
1501
	public static function get_updates() {
1502
		$update_data = wp_get_update_data();
1503
1504
		// Stores the individual update counts as well as the total count.
1505
		if ( isset( $update_data['counts'] ) ) {
1506
			$updates = $update_data['counts'];
1507
		}
1508
1509
		// If we need to update WordPress core, let's find the latest version number.
1510 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1511
			$cur = get_preferred_from_update_core();
1512
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1513
				$updates['wp_update_version'] = $cur->current;
1514
			}
1515
		}
1516
		return isset( $updates ) ? $updates : array();
1517
	}
1518
1519
	public static function get_update_details() {
1520
		$update_details = array(
1521
			'update_core'    => get_site_transient( 'update_core' ),
1522
			'update_plugins' => get_site_transient( 'update_plugins' ),
1523
			'update_themes'  => get_site_transient( 'update_themes' ),
1524
		);
1525
		return $update_details;
1526
	}
1527
1528
	public static function refresh_update_data() {
1529
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1530
1531
	}
1532
1533
	public static function refresh_theme_data() {
1534
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1535
	}
1536
1537
	/**
1538
	 * Is Jetpack active?
1539
	 */
1540
	public static function is_active() {
1541
		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...
1542
	}
1543
1544
	/**
1545
	 * Make an API call to WordPress.com for plan status
1546
	 *
1547
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1548
	 *
1549
	 * @return bool True if plan is updated, false if no update
1550
	 */
1551
	public static function refresh_active_plan_from_wpcom() {
1552
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1553
		return Jetpack_Plan::refresh_from_wpcom();
1554
	}
1555
1556
	/**
1557
	 * Get the plan that this Jetpack site is currently using
1558
	 *
1559
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1560
	 * @return array Active Jetpack plan details.
1561
	 */
1562
	public static function get_active_plan() {
1563
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1564
		return Jetpack_Plan::get();
1565
	}
1566
1567
	/**
1568
	 * Determine whether the active plan supports a particular feature
1569
	 *
1570
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1571
	 * @return bool True if plan supports feature, false if not.
1572
	 */
1573
	public static function active_plan_supports( $feature ) {
1574
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1575
		return Jetpack_Plan::supports( $feature );
1576
	}
1577
1578
	/**
1579
	 * Deprecated: Is Jetpack in development (offline) mode?
1580
	 *
1581
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1582
	 * and themes still use it, and we do not want to flood them with notices.
1583
	 *
1584
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1585
	 *
1586
	 * @deprecated since 8.0.
1587
	 */
1588
	public static function is_development_mode() {
1589
		return ( new Status() )->is_development_mode();
1590
	}
1591
1592
	/**
1593
	 * Whether the site is currently onboarding or not.
1594
	 * A site is considered as being onboarded if it currently has an onboarding token.
1595
	 *
1596
	 * @since 5.8
1597
	 *
1598
	 * @access public
1599
	 * @static
1600
	 *
1601
	 * @return bool True if the site is currently onboarding, false otherwise
1602
	 */
1603
	public static function is_onboarding() {
1604
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1605
	}
1606
1607
	/**
1608
	 * Determines reason for Jetpack development mode.
1609
	 */
1610
	public static function development_mode_trigger_text() {
1611
		if ( ! ( new Status() )->is_development_mode() ) {
1612
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1613
		}
1614
1615
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1616
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1617
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1618
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1619
		} else {
1620
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1621
		}
1622
1623
		return $notice;
1624
1625
	}
1626
	/**
1627
	 * Get Jetpack development mode notice text and notice class.
1628
	 *
1629
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1630
	 */
1631
	public static function show_development_mode_notice() {
1632 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1633
			$notice = sprintf(
1634
				/* translators: %s is a URL */
1635
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1636
				'https://jetpack.com/support/development-mode/'
1637
			);
1638
1639
			$notice .= ' ' . self::development_mode_trigger_text();
1640
1641
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1642
		}
1643
1644
		// Throw up a notice if using a development version and as for feedback.
1645
		if ( self::is_development_version() ) {
1646
			/* translators: %s is a URL */
1647
			$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/' );
1648
1649
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1650
		}
1651
		// Throw up a notice if using staging mode
1652
		if ( self::is_staging_site() ) {
1653
			/* translators: %s is a URL */
1654
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1655
1656
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1657
		}
1658
	}
1659
1660
	/**
1661
	 * Whether Jetpack's version maps to a public release, or a development version.
1662
	 */
1663
	public static function is_development_version() {
1664
		/**
1665
		 * Allows filtering whether this is a development version of Jetpack.
1666
		 *
1667
		 * This filter is especially useful for tests.
1668
		 *
1669
		 * @since 4.3.0
1670
		 *
1671
		 * @param bool $development_version Is this a develoment version of Jetpack?
1672
		 */
1673
		return (bool) apply_filters(
1674
			'jetpack_development_version',
1675
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1676
		);
1677
	}
1678
1679
	/**
1680
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1681
	 */
1682
	public static function is_user_connected( $user_id = false ) {
1683
		return self::connection()->is_user_connected( $user_id );
1684
	}
1685
1686
	/**
1687
	 * Get the wpcom user data of the current|specified connected user.
1688
	 */
1689 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1690
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1691
		if ( ! $user_id ) {
1692
			$user_id = get_current_user_id();
1693
		}
1694
1695
		$transient_key = "jetpack_connected_user_data_$user_id";
1696
1697
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1698
			return $cached_user_data;
1699
		}
1700
1701
		$xml = new Jetpack_IXR_Client(
1702
			array(
1703
				'user_id' => $user_id,
1704
			)
1705
		);
1706
		$xml->query( 'wpcom.getUser' );
1707
		if ( ! $xml->isError() ) {
1708
			$user_data = $xml->getResponse();
1709
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1710
			return $user_data;
1711
		}
1712
1713
		return false;
1714
	}
1715
1716
	/**
1717
	 * Get the wpcom email of the current|specified connected user.
1718
	 */
1719 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1720
		if ( ! $user_id ) {
1721
			$user_id = get_current_user_id();
1722
		}
1723
1724
		$xml = new Jetpack_IXR_Client(
1725
			array(
1726
				'user_id' => $user_id,
1727
			)
1728
		);
1729
		$xml->query( 'wpcom.getUserEmail' );
1730
		if ( ! $xml->isError() ) {
1731
			return $xml->getResponse();
1732
		}
1733
		return false;
1734
	}
1735
1736
	/**
1737
	 * Get the wpcom email of the master user.
1738
	 */
1739
	public static function get_master_user_email() {
1740
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1741
		if ( $master_user_id ) {
1742
			return self::get_connected_user_email( $master_user_id );
1743
		}
1744
		return '';
1745
	}
1746
1747
	/**
1748
	 * Whether the current user is the connection owner.
1749
	 *
1750
	 * @deprecated since 7.7
1751
	 *
1752
	 * @return bool Whether the current user is the connection owner.
1753
	 */
1754
	public function current_user_is_connection_owner() {
1755
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1756
		return self::connection()->is_connection_owner();
1757
	}
1758
1759
	/**
1760
	 * Gets current user IP address.
1761
	 *
1762
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1763
	 *
1764
	 * @return string                  Current user IP address.
1765
	 */
1766
	public static function current_user_ip( $check_all_headers = false ) {
1767
		if ( $check_all_headers ) {
1768
			foreach ( array(
1769
				'HTTP_CF_CONNECTING_IP',
1770
				'HTTP_CLIENT_IP',
1771
				'HTTP_X_FORWARDED_FOR',
1772
				'HTTP_X_FORWARDED',
1773
				'HTTP_X_CLUSTER_CLIENT_IP',
1774
				'HTTP_FORWARDED_FOR',
1775
				'HTTP_FORWARDED',
1776
				'HTTP_VIA',
1777
			) as $key ) {
1778
				if ( ! empty( $_SERVER[ $key ] ) ) {
1779
					return $_SERVER[ $key ];
1780
				}
1781
			}
1782
		}
1783
1784
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1785
	}
1786
1787
	/**
1788
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1789
	 */
1790
	function extra_oembed_providers() {
1791
		// Cloudup: https://dev.cloudup.com/#oembed
1792
		wp_oembed_add_provider( 'https://cloudup.com/*', 'https://cloudup.com/oembed' );
1793
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1794
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1795
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1796
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1797
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1798
		wp_oembed_add_provider( 'https://song.link/*', 'https://song.link/oembed', false );
1799
	}
1800
1801
	/**
1802
	 * Synchronize connected user role changes
1803
	 */
1804
	function user_role_change( $user_id ) {
1805
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1806
		Users::user_role_change( $user_id );
1807
	}
1808
1809
	/**
1810
	 * Loads the currently active modules.
1811
	 */
1812
	public static function load_modules() {
1813
		$is_development_mode = ( new Status() )->is_development_mode();
1814
		if (
1815
			! self::is_active()
1816
			&& ! $is_development_mode
1817
			&& ! self::is_onboarding()
1818
			&& (
1819
				! is_multisite()
1820
				|| ! get_site_option( 'jetpack_protect_active' )
1821
			)
1822
		) {
1823
			return;
1824
		}
1825
1826
		$version = Jetpack_Options::get_option( 'version' );
1827 View Code Duplication
		if ( ! $version ) {
1828
			$version = $old_version = JETPACK__VERSION . ':' . time();
1829
			/** This action is documented in class.jetpack.php */
1830
			do_action( 'updating_jetpack_version', $version, false );
1831
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1832
		}
1833
		list( $version ) = explode( ':', $version );
1834
1835
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1836
1837
		$modules_data = array();
1838
1839
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1840
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1841
			$updated_modules = array();
1842
			foreach ( $modules as $module ) {
1843
				$modules_data[ $module ] = self::get_module( $module );
1844
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1845
					continue;
1846
				}
1847
1848
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1849
					continue;
1850
				}
1851
1852
				$updated_modules[] = $module;
1853
			}
1854
1855
			$modules = array_diff( $modules, $updated_modules );
1856
		}
1857
1858
		foreach ( $modules as $index => $module ) {
1859
			// If we're in dev mode, disable modules requiring a connection
1860
			if ( $is_development_mode ) {
1861
				// Prime the pump if we need to
1862
				if ( empty( $modules_data[ $module ] ) ) {
1863
					$modules_data[ $module ] = self::get_module( $module );
1864
				}
1865
				// If the module requires a connection, but we're in local mode, don't include it.
1866
				if ( $modules_data[ $module ]['requires_connection'] ) {
1867
					continue;
1868
				}
1869
			}
1870
1871
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1872
				continue;
1873
			}
1874
1875
			if ( ! include_once self::get_module_path( $module ) ) {
1876
				unset( $modules[ $index ] );
1877
				self::update_active_modules( array_values( $modules ) );
1878
				continue;
1879
			}
1880
1881
			/**
1882
			 * Fires when a specific module is loaded.
1883
			 * The dynamic part of the hook, $module, is the module slug.
1884
			 *
1885
			 * @since 1.1.0
1886
			 */
1887
			do_action( 'jetpack_module_loaded_' . $module );
1888
		}
1889
1890
		/**
1891
		 * Fires when all the modules are loaded.
1892
		 *
1893
		 * @since 1.1.0
1894
		 */
1895
		do_action( 'jetpack_modules_loaded' );
1896
1897
		// 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.
1898
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1899
	}
1900
1901
	/**
1902
	 * Check if Jetpack's REST API compat file should be included
1903
	 *
1904
	 * @action plugins_loaded
1905
	 * @return null
1906
	 */
1907
	public function check_rest_api_compat() {
1908
		/**
1909
		 * Filters the list of REST API compat files to be included.
1910
		 *
1911
		 * @since 2.2.5
1912
		 *
1913
		 * @param array $args Array of REST API compat files to include.
1914
		 */
1915
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1916
1917
		if ( function_exists( 'bbpress' ) ) {
1918
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1919
		}
1920
1921
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1922
			require_once $_jetpack_rest_api_compat_include;
1923
		}
1924
	}
1925
1926
	/**
1927
	 * Gets all plugins currently active in values, regardless of whether they're
1928
	 * traditionally activated or network activated.
1929
	 *
1930
	 * @todo Store the result in core's object cache maybe?
1931
	 */
1932
	public static function get_active_plugins() {
1933
		$active_plugins = (array) get_option( 'active_plugins', array() );
1934
1935
		if ( is_multisite() ) {
1936
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1937
			// whereas active_plugins stores them in the values.
1938
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1939
			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...
1940
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1941
			}
1942
		}
1943
1944
		sort( $active_plugins );
1945
1946
		return array_unique( $active_plugins );
1947
	}
1948
1949
	/**
1950
	 * Gets and parses additional plugin data to send with the heartbeat data
1951
	 *
1952
	 * @since 3.8.1
1953
	 *
1954
	 * @return array Array of plugin data
1955
	 */
1956
	public static function get_parsed_plugin_data() {
1957
		if ( ! function_exists( 'get_plugins' ) ) {
1958
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
1959
		}
1960
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1961
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1962
		$active_plugins = self::get_active_plugins();
1963
1964
		$plugins = array();
1965
		foreach ( $all_plugins as $path => $plugin_data ) {
1966
			$plugins[ $path ] = array(
1967
				'is_active' => in_array( $path, $active_plugins ),
1968
				'file'      => $path,
1969
				'name'      => $plugin_data['Name'],
1970
				'version'   => $plugin_data['Version'],
1971
				'author'    => $plugin_data['Author'],
1972
			);
1973
		}
1974
1975
		return $plugins;
1976
	}
1977
1978
	/**
1979
	 * Gets and parses theme data to send with the heartbeat data
1980
	 *
1981
	 * @since 3.8.1
1982
	 *
1983
	 * @return array Array of theme data
1984
	 */
1985
	public static function get_parsed_theme_data() {
1986
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
1987
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1988
1989
		$themes = array();
1990
		foreach ( $all_themes as $slug => $theme_data ) {
1991
			$theme_headers = array();
1992
			foreach ( $header_keys as $header_key ) {
1993
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1994
			}
1995
1996
			$themes[ $slug ] = array(
1997
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
1998
				'slug'            => $slug,
1999
				'theme_root'      => $theme_data->get_theme_root_uri(),
2000
				'parent'          => $theme_data->parent(),
2001
				'headers'         => $theme_headers,
2002
			);
2003
		}
2004
2005
		return $themes;
2006
	}
2007
2008
	/**
2009
	 * Checks whether a specific plugin is active.
2010
	 *
2011
	 * We don't want to store these in a static variable, in case
2012
	 * there are switch_to_blog() calls involved.
2013
	 */
2014
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2015
		return in_array( $plugin, self::get_active_plugins() );
2016
	}
2017
2018
	/**
2019
	 * Check if Jetpack's Open Graph tags should be used.
2020
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2021
	 *
2022
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2023
	 * @action plugins_loaded
2024
	 * @return null
2025
	 */
2026
	public function check_open_graph() {
2027
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2028
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2029
		}
2030
2031
		$active_plugins = self::get_active_plugins();
2032
2033
		if ( ! empty( $active_plugins ) ) {
2034
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2035
				if ( in_array( $plugin, $active_plugins ) ) {
2036
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2037
					break;
2038
				}
2039
			}
2040
		}
2041
2042
		/**
2043
		 * Allow the addition of Open Graph Meta Tags to all pages.
2044
		 *
2045
		 * @since 2.0.3
2046
		 *
2047
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2048
		 */
2049
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2050
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2051
		}
2052
	}
2053
2054
	/**
2055
	 * Check if Jetpack's Twitter tags should be used.
2056
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2057
	 *
2058
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2059
	 * @action plugins_loaded
2060
	 * @return null
2061
	 */
2062
	public function check_twitter_tags() {
2063
2064
		$active_plugins = self::get_active_plugins();
2065
2066
		if ( ! empty( $active_plugins ) ) {
2067
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2068
				if ( in_array( $plugin, $active_plugins ) ) {
2069
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2070
					break;
2071
				}
2072
			}
2073
		}
2074
2075
		/**
2076
		 * Allow Twitter Card Meta tags to be disabled.
2077
		 *
2078
		 * @since 2.6.0
2079
		 *
2080
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2081
		 */
2082
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2083
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2084
		}
2085
	}
2086
2087
	/**
2088
	 * Allows plugins to submit security reports.
2089
	 *
2090
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2091
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2092
	 * @param array  $args         See definitions above
2093
	 */
2094
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2095
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2096
	}
2097
2098
	/* Jetpack Options API */
2099
2100
	public static function get_option_names( $type = 'compact' ) {
2101
		return Jetpack_Options::get_option_names( $type );
2102
	}
2103
2104
	/**
2105
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2106
	 *
2107
	 * @param string $name    Option name
2108
	 * @param mixed  $default (optional)
2109
	 */
2110
	public static function get_option( $name, $default = false ) {
2111
		return Jetpack_Options::get_option( $name, $default );
2112
	}
2113
2114
	/**
2115
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2116
	 *
2117
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2118
	 * @param string $name  Option name
2119
	 * @param mixed  $value Option value
2120
	 */
2121
	public static function update_option( $name, $value ) {
2122
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2123
		return Jetpack_Options::update_option( $name, $value );
2124
	}
2125
2126
	/**
2127
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2128
	 *
2129
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2130
	 * @param array $array array( option name => option value, ... )
2131
	 */
2132
	public static function update_options( $array ) {
2133
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2134
		return Jetpack_Options::update_options( $array );
2135
	}
2136
2137
	/**
2138
	 * Deletes the given option.  May be passed multiple option names as an array.
2139
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2140
	 *
2141
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2142
	 * @param string|array $names
2143
	 */
2144
	public static function delete_option( $names ) {
2145
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2146
		return Jetpack_Options::delete_option( $names );
2147
	}
2148
2149
	/**
2150
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2151
	 *
2152
	 * Enters a user token into the user_tokens option
2153
	 *
2154
	 * @param int    $user_id The user id.
2155
	 * @param string $token The user token.
2156
	 * @param bool   $is_master_user Whether the user is the master user.
2157
	 * @return bool
2158
	 */
2159
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2160
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2161
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2162
	}
2163
2164
	/**
2165
	 * Returns an array of all PHP files in the specified absolute path.
2166
	 * Equivalent to glob( "$absolute_path/*.php" ).
2167
	 *
2168
	 * @param string $absolute_path The absolute path of the directory to search.
2169
	 * @return array Array of absolute paths to the PHP files.
2170
	 */
2171
	public static function glob_php( $absolute_path ) {
2172
		if ( function_exists( 'glob' ) ) {
2173
			return glob( "$absolute_path/*.php" );
2174
		}
2175
2176
		$absolute_path = untrailingslashit( $absolute_path );
2177
		$files         = array();
2178
		if ( ! $dir = @opendir( $absolute_path ) ) {
2179
			return $files;
2180
		}
2181
2182
		while ( false !== $file = readdir( $dir ) ) {
2183
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2184
				continue;
2185
			}
2186
2187
			$file = "$absolute_path/$file";
2188
2189
			if ( ! is_file( $file ) ) {
2190
				continue;
2191
			}
2192
2193
			$files[] = $file;
2194
		}
2195
2196
		closedir( $dir );
2197
2198
		return $files;
2199
	}
2200
2201
	public static function activate_new_modules( $redirect = false ) {
2202
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2203
			return;
2204
		}
2205
2206
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2207 View Code Duplication
		if ( ! $jetpack_old_version ) {
2208
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2209
			/** This action is documented in class.jetpack.php */
2210
			do_action( 'updating_jetpack_version', $version, false );
2211
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2212
		}
2213
2214
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2215
2216
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2217
			return;
2218
		}
2219
2220
		$active_modules     = self::get_active_modules();
2221
		$reactivate_modules = array();
2222
		foreach ( $active_modules as $active_module ) {
2223
			$module = self::get_module( $active_module );
2224
			if ( ! isset( $module['changed'] ) ) {
2225
				continue;
2226
			}
2227
2228
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2229
				continue;
2230
			}
2231
2232
			$reactivate_modules[] = $active_module;
2233
			self::deactivate_module( $active_module );
2234
		}
2235
2236
		$new_version = JETPACK__VERSION . ':' . time();
2237
		/** This action is documented in class.jetpack.php */
2238
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2239
		Jetpack_Options::update_options(
2240
			array(
2241
				'version'     => $new_version,
2242
				'old_version' => $jetpack_old_version,
2243
			)
2244
		);
2245
2246
		self::state( 'message', 'modules_activated' );
2247
		self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2248
2249
		if ( $redirect ) {
2250
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2251
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2252
				$page = $_GET['page'];
2253
			}
2254
2255
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2256
			exit;
2257
		}
2258
	}
2259
2260
	/**
2261
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2262
	 * Make sure to tuck away module "library" files in a sub-directory.
2263
	 */
2264
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2265
		static $modules = null;
2266
2267
		if ( ! isset( $modules ) ) {
2268
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2269
			// Use the cache if we're on the front-end and it's available...
2270
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2271
				$modules = $available_modules_option[ JETPACK__VERSION ];
2272
			} else {
2273
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2274
2275
				$modules = array();
2276
2277
				foreach ( $files as $file ) {
2278
					if ( ! $headers = self::get_module( $file ) ) {
2279
						continue;
2280
					}
2281
2282
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2283
				}
2284
2285
				Jetpack_Options::update_option(
2286
					'available_modules',
2287
					array(
2288
						JETPACK__VERSION => $modules,
2289
					)
2290
				);
2291
			}
2292
		}
2293
2294
		/**
2295
		 * Filters the array of modules available to be activated.
2296
		 *
2297
		 * @since 2.4.0
2298
		 *
2299
		 * @param array $modules Array of available modules.
2300
		 * @param string $min_version Minimum version number required to use modules.
2301
		 * @param string $max_version Maximum version number required to use modules.
2302
		 */
2303
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2304
2305
		if ( ! $min_version && ! $max_version ) {
2306
			return array_keys( $mods );
2307
		}
2308
2309
		$r = array();
2310
		foreach ( $mods as $slug => $introduced ) {
2311
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2312
				continue;
2313
			}
2314
2315
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2316
				continue;
2317
			}
2318
2319
			$r[] = $slug;
2320
		}
2321
2322
		return $r;
2323
	}
2324
2325
	/**
2326
	 * Default modules loaded on activation.
2327
	 */
2328
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2329
		$return = array();
2330
2331
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2332
			$module_data = self::get_module( $module );
2333
2334
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2335
				case 'yes':
2336
					$return[] = $module;
2337
					break;
2338
				case 'public':
2339
					if ( Jetpack_Options::get_option( 'public' ) ) {
2340
						$return[] = $module;
2341
					}
2342
					break;
2343
				case 'no':
2344
				default:
2345
					break;
2346
			}
2347
		}
2348
		/**
2349
		 * Filters the array of default modules.
2350
		 *
2351
		 * @since 2.5.0
2352
		 *
2353
		 * @param array $return Array of default modules.
2354
		 * @param string $min_version Minimum version number required to use modules.
2355
		 * @param string $max_version Maximum version number required to use modules.
2356
		 */
2357
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2358
	}
2359
2360
	/**
2361
	 * Checks activated modules during auto-activation to determine
2362
	 * if any of those modules are being deprecated.  If so, close
2363
	 * them out, and add any replacement modules.
2364
	 *
2365
	 * Runs at priority 99 by default.
2366
	 *
2367
	 * This is run late, so that it can still activate a module if
2368
	 * the new module is a replacement for another that the user
2369
	 * currently has active, even if something at the normal priority
2370
	 * would kibosh everything.
2371
	 *
2372
	 * @since 2.6
2373
	 * @uses jetpack_get_default_modules filter
2374
	 * @param array $modules
2375
	 * @return array
2376
	 */
2377
	function handle_deprecated_modules( $modules ) {
2378
		$deprecated_modules = array(
2379
			'debug'            => null,  // Closed out and moved to the debugger library.
2380
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2381
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2382
		);
2383
2384
		// Don't activate SSO if they never completed activating WPCC.
2385
		if ( self::is_module_active( 'wpcc' ) ) {
2386
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2387
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2388
				$deprecated_modules['wpcc'] = null;
2389
			}
2390
		}
2391
2392
		foreach ( $deprecated_modules as $module => $replacement ) {
2393
			if ( self::is_module_active( $module ) ) {
2394
				self::deactivate_module( $module );
2395
				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...
2396
					$modules[] = $replacement;
2397
				}
2398
			}
2399
		}
2400
2401
		return array_unique( $modules );
2402
	}
2403
2404
	/**
2405
	 * Checks activated plugins during auto-activation to determine
2406
	 * if any of those plugins are in the list with a corresponding module
2407
	 * that is not compatible with the plugin. The module will not be allowed
2408
	 * to auto-activate.
2409
	 *
2410
	 * @since 2.6
2411
	 * @uses jetpack_get_default_modules filter
2412
	 * @param array $modules
2413
	 * @return array
2414
	 */
2415
	function filter_default_modules( $modules ) {
2416
2417
		$active_plugins = self::get_active_plugins();
2418
2419
		if ( ! empty( $active_plugins ) ) {
2420
2421
			// For each module we'd like to auto-activate...
2422
			foreach ( $modules as $key => $module ) {
2423
				// If there are potential conflicts for it...
2424
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2425
					// For each potential conflict...
2426
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2427
						// If that conflicting plugin is active...
2428
						if ( in_array( $plugin, $active_plugins ) ) {
2429
							// Remove that item from being auto-activated.
2430
							unset( $modules[ $key ] );
2431
						}
2432
					}
2433
				}
2434
			}
2435
		}
2436
2437
		return $modules;
2438
	}
2439
2440
	/**
2441
	 * Extract a module's slug from its full path.
2442
	 */
2443
	public static function get_module_slug( $file ) {
2444
		return str_replace( '.php', '', basename( $file ) );
2445
	}
2446
2447
	/**
2448
	 * Generate a module's path from its slug.
2449
	 */
2450
	public static function get_module_path( $slug ) {
2451
		/**
2452
		 * Filters the path of a modules.
2453
		 *
2454
		 * @since 7.4.0
2455
		 *
2456
		 * @param array $return The absolute path to a module's root php file
2457
		 * @param string $slug The module slug
2458
		 */
2459
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2460
	}
2461
2462
	/**
2463
	 * Load module data from module file. Headers differ from WordPress
2464
	 * plugin headers to avoid them being identified as standalone
2465
	 * plugins on the WordPress plugins page.
2466
	 */
2467
	public static function get_module( $module ) {
2468
		$headers = array(
2469
			'name'                      => 'Module Name',
2470
			'description'               => 'Module Description',
2471
			'sort'                      => 'Sort Order',
2472
			'recommendation_order'      => 'Recommendation Order',
2473
			'introduced'                => 'First Introduced',
2474
			'changed'                   => 'Major Changes In',
2475
			'deactivate'                => 'Deactivate',
2476
			'free'                      => 'Free',
2477
			'requires_connection'       => 'Requires Connection',
2478
			'auto_activate'             => 'Auto Activate',
2479
			'module_tags'               => 'Module Tags',
2480
			'feature'                   => 'Feature',
2481
			'additional_search_queries' => 'Additional Search Queries',
2482
			'plan_classes'              => 'Plans',
2483
		);
2484
2485
		$file = self::get_module_path( self::get_module_slug( $module ) );
2486
2487
		$mod = self::get_file_data( $file, $headers );
2488
		if ( empty( $mod['name'] ) ) {
2489
			return false;
2490
		}
2491
2492
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2493
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2494
		$mod['deactivate']           = empty( $mod['deactivate'] );
2495
		$mod['free']                 = empty( $mod['free'] );
2496
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2497
2498
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2499
			$mod['auto_activate'] = 'No';
2500
		} else {
2501
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2502
		}
2503
2504
		if ( $mod['module_tags'] ) {
2505
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2506
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2507
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2508
		} else {
2509
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2510
		}
2511
2512 View Code Duplication
		if ( $mod['plan_classes'] ) {
2513
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2514
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2515
		} else {
2516
			$mod['plan_classes'] = array( 'free' );
2517
		}
2518
2519 View Code Duplication
		if ( $mod['feature'] ) {
2520
			$mod['feature'] = explode( ',', $mod['feature'] );
2521
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2522
		} else {
2523
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2524
		}
2525
2526
		/**
2527
		 * Filters the feature array on a module.
2528
		 *
2529
		 * This filter allows you to control where each module is filtered: Recommended,
2530
		 * and the default "Other" listing.
2531
		 *
2532
		 * @since 3.5.0
2533
		 *
2534
		 * @param array   $mod['feature'] The areas to feature this module:
2535
		 *     'Recommended' shows on the main Jetpack admin screen.
2536
		 *     'Other' should be the default if no other value is in the array.
2537
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2538
		 * @param array   $mod All the currently assembled module data.
2539
		 */
2540
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2541
2542
		/**
2543
		 * Filter the returned data about a module.
2544
		 *
2545
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2546
		 * so please be careful.
2547
		 *
2548
		 * @since 3.6.0
2549
		 *
2550
		 * @param array   $mod    The details of the requested module.
2551
		 * @param string  $module The slug of the module, e.g. sharedaddy
2552
		 * @param string  $file   The path to the module source file.
2553
		 */
2554
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2555
	}
2556
2557
	/**
2558
	 * Like core's get_file_data implementation, but caches the result.
2559
	 */
2560
	public static function get_file_data( $file, $headers ) {
2561
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2562
		$file_name = basename( $file );
2563
2564
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2565
2566
		$file_data_option = get_transient( $cache_key );
2567
2568
		if ( ! is_array( $file_data_option ) ) {
2569
			delete_transient( $cache_key );
2570
			$file_data_option = false;
2571
		}
2572
2573
		if ( false === $file_data_option ) {
2574
			$file_data_option = array();
2575
		}
2576
2577
		$key           = md5( $file_name . serialize( $headers ) );
2578
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2579
2580
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2581
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2582
			return $file_data_option[ $key ];
2583
		}
2584
2585
		$data = get_file_data( $file, $headers );
2586
2587
		$file_data_option[ $key ] = $data;
2588
2589
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2590
2591
		return $data;
2592
	}
2593
2594
2595
	/**
2596
	 * Return translated module tag.
2597
	 *
2598
	 * @param string $tag Tag as it appears in each module heading.
2599
	 *
2600
	 * @return mixed
2601
	 */
2602
	public static function translate_module_tag( $tag ) {
2603
		return jetpack_get_module_i18n_tag( $tag );
2604
	}
2605
2606
	/**
2607
	 * Get i18n strings as a JSON-encoded string
2608
	 *
2609
	 * @return string The locale as JSON
2610
	 */
2611
	public static function get_i18n_data_json() {
2612
2613
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2614
		// JSON files with the file they should be included for. This is an md5
2615
		// of '_inc/build/admin.js'.
2616
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2617
2618
		$i18n_json =
2619
				   JETPACK__PLUGIN_DIR
2620
				   . 'languages/json/jetpack-'
2621
				   . get_user_locale()
2622
				   . '-'
2623
				   . $path_md5
2624
				   . '.json';
2625
2626
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2627
			$locale_data = @file_get_contents( $i18n_json );
2628
			if ( $locale_data ) {
2629
				return $locale_data;
2630
			}
2631
		}
2632
2633
		// Return valid empty Jed locale
2634
		return '{ "locale_data": { "messages": { "": {} } } }';
2635
	}
2636
2637
	/**
2638
	 * Add locale data setup to wp-i18n
2639
	 *
2640
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2641
	 *
2642
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2643
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2644
	 *
2645
	 * This method provides a safe way to request the setup multiple times but add the script at
2646
	 * most once.
2647
	 *
2648
	 * @since 6.7.0
2649
	 *
2650
	 * @return void
2651
	 */
2652
	public static function setup_wp_i18n_locale_data() {
2653
		static $script_added = false;
2654
		if ( ! $script_added ) {
2655
			$script_added = true;
2656
			wp_add_inline_script(
2657
				'wp-i18n',
2658
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2659
			);
2660
		}
2661
	}
2662
2663
	/**
2664
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2665
	 *
2666
	 * @since 3.9.2
2667
	 *
2668
	 * @param array $modules
2669
	 *
2670
	 * @return string|void
2671
	 */
2672
	public static function get_translated_modules( $modules ) {
2673
		foreach ( $modules as $index => $module ) {
2674
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2675
			if ( isset( $module['name'] ) ) {
2676
				$modules[ $index ]['name'] = $i18n_module['name'];
2677
			}
2678
			if ( isset( $module['description'] ) ) {
2679
				$modules[ $index ]['description']       = $i18n_module['description'];
2680
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2681
			}
2682
		}
2683
		return $modules;
2684
	}
2685
2686
	/**
2687
	 * Get a list of activated modules as an array of module slugs.
2688
	 */
2689
	public static function get_active_modules() {
2690
		$active = Jetpack_Options::get_option( 'active_modules' );
2691
2692
		if ( ! is_array( $active ) ) {
2693
			$active = array();
2694
		}
2695
2696
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2697
			$active[] = 'vaultpress';
2698
		} else {
2699
			$active = array_diff( $active, array( 'vaultpress' ) );
2700
		}
2701
2702
		// If protect is active on the main site of a multisite, it should be active on all sites.
2703
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2704
			$active[] = 'protect';
2705
		}
2706
2707
		/**
2708
		 * Allow filtering of the active modules.
2709
		 *
2710
		 * Gives theme and plugin developers the power to alter the modules that
2711
		 * are activated on the fly.
2712
		 *
2713
		 * @since 5.8.0
2714
		 *
2715
		 * @param array $active Array of active module slugs.
2716
		 */
2717
		$active = apply_filters( 'jetpack_active_modules', $active );
2718
2719
		return array_unique( $active );
2720
	}
2721
2722
	/**
2723
	 * Check whether or not a Jetpack module is active.
2724
	 *
2725
	 * @param string $module The slug of a Jetpack module.
2726
	 * @return bool
2727
	 *
2728
	 * @static
2729
	 */
2730
	public static function is_module_active( $module ) {
2731
		return in_array( $module, self::get_active_modules() );
2732
	}
2733
2734
	public static function is_module( $module ) {
2735
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2736
	}
2737
2738
	/**
2739
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2740
	 *
2741
	 * @param bool $catch True to start catching, False to stop.
2742
	 *
2743
	 * @static
2744
	 */
2745
	public static function catch_errors( $catch ) {
2746
		static $display_errors, $error_reporting;
2747
2748
		if ( $catch ) {
2749
			$display_errors  = @ini_set( 'display_errors', 1 );
2750
			$error_reporting = @error_reporting( E_ALL );
2751
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2752
		} else {
2753
			@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...
2754
			@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...
2755
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2756
		}
2757
	}
2758
2759
	/**
2760
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2761
	 */
2762
	public static function catch_errors_on_shutdown() {
2763
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2764
	}
2765
2766
	/**
2767
	 * Rewrite any string to make paths easier to read.
2768
	 *
2769
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2770
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2771
	 *
2772
	 * @param $string
2773
	 * @return mixed
2774
	 */
2775
	public static function alias_directories( $string ) {
2776
		// ABSPATH has a trailing slash.
2777
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2778
		// WP_CONTENT_DIR does not have a trailing slash.
2779
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2780
2781
		return $string;
2782
	}
2783
2784
	public static function activate_default_modules(
2785
		$min_version = false,
2786
		$max_version = false,
2787
		$other_modules = array(),
2788
		$redirect = null,
2789
		$send_state_messages = null
2790
	) {
2791
		$jetpack = self::init();
2792
2793
		if ( is_null( $redirect ) ) {
2794
			if (
2795
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2796
			||
2797
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2798
			||
2799
				( defined( 'WP_CLI' ) && WP_CLI )
2800
			||
2801
				( defined( 'DOING_CRON' ) && DOING_CRON )
2802
			||
2803
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2804
			) {
2805
				$redirect = false;
2806
			} elseif ( is_admin() ) {
2807
				$redirect = true;
2808
			} else {
2809
				$redirect = false;
2810
			}
2811
		}
2812
2813
		if ( is_null( $send_state_messages ) ) {
2814
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2815
		}
2816
2817
		$modules = self::get_default_modules( $min_version, $max_version );
2818
		$modules = array_merge( $other_modules, $modules );
2819
2820
		// Look for standalone plugins and disable if active.
2821
2822
		$to_deactivate = array();
2823
		foreach ( $modules as $module ) {
2824
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2825
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2826
			}
2827
		}
2828
2829
		$deactivated = array();
2830
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2831
			list( $probable_file, $probable_title ) = $deactivate_me;
2832
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2833
				$deactivated[] = $module;
2834
			}
2835
		}
2836
2837
		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...
2838
			if ( $send_state_messages ) {
2839
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2840
			}
2841
2842
			if ( $redirect ) {
2843
				$url = add_query_arg(
2844
					array(
2845
						'action'   => 'activate_default_modules',
2846
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2847
					),
2848
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2849
				);
2850
				wp_safe_redirect( $url );
2851
				exit;
2852
			}
2853
		}
2854
2855
		/**
2856
		 * Fires before default modules are activated.
2857
		 *
2858
		 * @since 1.9.0
2859
		 *
2860
		 * @param string $min_version Minimum version number required to use modules.
2861
		 * @param string $max_version Maximum version number required to use modules.
2862
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2863
		 */
2864
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2865
2866
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2867
		if ( $send_state_messages ) {
2868
			self::restate();
2869
			self::catch_errors( true );
2870
		}
2871
2872
		$active = self::get_active_modules();
2873
2874
		foreach ( $modules as $module ) {
2875
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2876
				$active[] = $module;
2877
				self::update_active_modules( $active );
2878
				continue;
2879
			}
2880
2881
			if ( $send_state_messages && in_array( $module, $active ) ) {
2882
				$module_info = self::get_module( $module );
2883 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2884
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2885
					if ( $active_state = self::state( $state ) ) {
2886
						$active_state = explode( ',', $active_state );
2887
					} else {
2888
						$active_state = array();
2889
					}
2890
					$active_state[] = $module;
2891
					self::state( $state, implode( ',', $active_state ) );
2892
				}
2893
				continue;
2894
			}
2895
2896
			$file = self::get_module_path( $module );
2897
			if ( ! file_exists( $file ) ) {
2898
				continue;
2899
			}
2900
2901
			// we'll override this later if the plugin can be included without fatal error
2902
			if ( $redirect ) {
2903
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2904
			}
2905
2906
			if ( $send_state_messages ) {
2907
				self::state( 'error', 'module_activation_failed' );
2908
				self::state( 'module', $module );
2909
			}
2910
2911
			ob_start();
2912
			require_once $file;
2913
2914
			$active[] = $module;
2915
2916 View Code Duplication
			if ( $send_state_messages ) {
2917
2918
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2919
				if ( $active_state = self::state( $state ) ) {
2920
					$active_state = explode( ',', $active_state );
2921
				} else {
2922
					$active_state = array();
2923
				}
2924
				$active_state[] = $module;
2925
				self::state( $state, implode( ',', $active_state ) );
2926
			}
2927
2928
			self::update_active_modules( $active );
2929
2930
			ob_end_clean();
2931
		}
2932
2933
		if ( $send_state_messages ) {
2934
			self::state( 'error', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2936
		}
2937
2938
		self::catch_errors( false );
2939
		/**
2940
		 * Fires when default modules are activated.
2941
		 *
2942
		 * @since 1.9.0
2943
		 *
2944
		 * @param string $min_version Minimum version number required to use modules.
2945
		 * @param string $max_version Maximum version number required to use modules.
2946
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2947
		 */
2948
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2949
	}
2950
2951
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2952
		/**
2953
		 * Fires before a module is activated.
2954
		 *
2955
		 * @since 2.6.0
2956
		 *
2957
		 * @param string $module Module slug.
2958
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2959
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2960
		 */
2961
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2962
2963
		$jetpack = self::init();
2964
2965
		if ( ! strlen( $module ) ) {
2966
			return false;
2967
		}
2968
2969
		if ( ! self::is_module( $module ) ) {
2970
			return false;
2971
		}
2972
2973
		// If it's already active, then don't do it again
2974
		$active = self::get_active_modules();
2975
		foreach ( $active as $act ) {
2976
			if ( $act == $module ) {
2977
				return true;
2978
			}
2979
		}
2980
2981
		$module_data = self::get_module( $module );
2982
2983
		$is_development_mode = ( new Status() )->is_development_mode();
2984
		if ( ! self::is_active() ) {
2985
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
2986
				return false;
2987
			}
2988
2989
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2990
			if ( $is_development_mode && $module_data['requires_connection'] ) {
2991
				return false;
2992
			}
2993
		}
2994
2995
		// Check and see if the old plugin is active
2996
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2997
			// Deactivate the old plugin
2998
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2999
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3000
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3001
				self::state( 'deactivated_plugins', $module );
3002
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3003
				exit;
3004
			}
3005
		}
3006
3007
		// Protect won't work with mis-configured IPs
3008
		if ( 'protect' === $module ) {
3009
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3010
			if ( ! jetpack_protect_get_ip() ) {
3011
				self::state( 'message', 'protect_misconfigured_ip' );
3012
				return false;
3013
			}
3014
		}
3015
3016
		if ( ! Jetpack_Plan::supports( $module ) ) {
3017
			return false;
3018
		}
3019
3020
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3021
		self::state( 'module', $module );
3022
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3023
3024
		self::catch_errors( true );
3025
		ob_start();
3026
		require self::get_module_path( $module );
3027
		/** This action is documented in class.jetpack.php */
3028
		do_action( 'jetpack_activate_module', $module );
3029
		$active[] = $module;
3030
		self::update_active_modules( $active );
3031
3032
		self::state( 'error', false ); // the override
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3033
		ob_end_clean();
3034
		self::catch_errors( false );
3035
3036
		if ( $redirect ) {
3037
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3038
		}
3039
		if ( $exit ) {
3040
			exit;
3041
		}
3042
		return true;
3043
	}
3044
3045
	function activate_module_actions( $module ) {
3046
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3047
	}
3048
3049
	public static function deactivate_module( $module ) {
3050
		/**
3051
		 * Fires when a module is deactivated.
3052
		 *
3053
		 * @since 1.9.0
3054
		 *
3055
		 * @param string $module Module slug.
3056
		 */
3057
		do_action( 'jetpack_pre_deactivate_module', $module );
3058
3059
		$jetpack = self::init();
0 ignored issues
show
Unused Code introduced by
$jetpack is not used, you could remove the assignment.

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

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

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

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

Loading history...
3060
3061
		$active = self::get_active_modules();
3062
		$new    = array_filter( array_diff( $active, (array) $module ) );
3063
3064
		return self::update_active_modules( $new );
3065
	}
3066
3067
	public static function enable_module_configurable( $module ) {
3068
		$module = self::get_module_slug( $module );
3069
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3070
	}
3071
3072
	/**
3073
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3074
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3075
	 *
3076
	 * @param string $module Module slug
3077
	 * @return string $url module configuration URL
3078
	 */
3079
	public static function module_configuration_url( $module ) {
3080
		$module      = self::get_module_slug( $module );
3081
		$default_url = self::admin_url() . "#/settings?term=$module";
3082
		/**
3083
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3084
		 *
3085
		 * @since 6.9.0
3086
		 *
3087
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3088
		 */
3089
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3090
3091
		return $url;
3092
	}
3093
3094
	/* Installation */
3095
	public static function bail_on_activation( $message, $deactivate = true ) {
3096
		?>
3097
<!doctype html>
3098
<html>
3099
<head>
3100
<meta charset="<?php bloginfo( 'charset' ); ?>">
3101
<style>
3102
* {
3103
	text-align: center;
3104
	margin: 0;
3105
	padding: 0;
3106
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3107
}
3108
p {
3109
	margin-top: 1em;
3110
	font-size: 18px;
3111
}
3112
</style>
3113
<body>
3114
<p><?php echo esc_html( $message ); ?></p>
3115
</body>
3116
</html>
3117
		<?php
3118
		if ( $deactivate ) {
3119
			$plugins = get_option( 'active_plugins' );
3120
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3121
			$update  = false;
3122
			foreach ( $plugins as $i => $plugin ) {
3123
				if ( $plugin === $jetpack ) {
3124
					$plugins[ $i ] = false;
3125
					$update        = true;
3126
				}
3127
			}
3128
3129
			if ( $update ) {
3130
				update_option( 'active_plugins', array_filter( $plugins ) );
3131
			}
3132
		}
3133
		exit;
3134
	}
3135
3136
	/**
3137
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3138
	 *
3139
	 * @static
3140
	 */
3141
	public static function plugin_activation( $network_wide ) {
3142
		Jetpack_Options::update_option( 'activated', 1 );
3143
3144
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3145
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3146
		}
3147
3148
		if ( $network_wide ) {
3149
			self::state( 'network_nag', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3150
		}
3151
3152
		// For firing one-off events (notices) immediately after activation
3153
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3154
3155
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3156
3157
		self::plugin_initialize();
3158
	}
3159
3160
	public static function get_activation_source( $referer_url ) {
3161
3162
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3163
			return array( 'wp-cli', null );
3164
		}
3165
3166
		$referer = wp_parse_url( $referer_url );
3167
3168
		$source_type  = 'unknown';
3169
		$source_query = null;
3170
3171
		if ( ! is_array( $referer ) ) {
3172
			return array( $source_type, $source_query );
3173
		}
3174
3175
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3176
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3177
3178
		if ( isset( $referer['query'] ) ) {
3179
			parse_str( $referer['query'], $query_parts );
3180
		} else {
3181
			$query_parts = array();
3182
		}
3183
3184
		if ( $plugins_path === $referer['path'] ) {
3185
			$source_type = 'list';
3186
		} elseif ( $plugins_install_path === $referer['path'] ) {
3187
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3188
			switch ( $tab ) {
3189
				case 'popular':
3190
					$source_type = 'popular';
3191
					break;
3192
				case 'recommended':
3193
					$source_type = 'recommended';
3194
					break;
3195
				case 'favorites':
3196
					$source_type = 'favorites';
3197
					break;
3198
				case 'search':
3199
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3200
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3201
					break;
3202
				default:
3203
					$source_type = 'featured';
3204
			}
3205
		}
3206
3207
		return array( $source_type, $source_query );
3208
	}
3209
3210
	/**
3211
	 * Runs before bumping version numbers up to a new version
3212
	 *
3213
	 * @param  string $version    Version:timestamp
3214
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3215
	 * @return null              [description]
3216
	 */
3217
	public static function do_version_bump( $version, $old_version ) {
3218
		if ( ! $old_version ) { // For new sites
3219
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3220
		}
3221
	}
3222
3223
	/**
3224
	 * Sets the internal version number and activation state.
3225
	 *
3226
	 * @static
3227
	 */
3228
	public static function plugin_initialize() {
3229
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3230
			Jetpack_Options::update_option( 'activated', 2 );
3231
		}
3232
3233 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3234
			$version = $old_version = JETPACK__VERSION . ':' . time();
3235
			/** This action is documented in class.jetpack.php */
3236
			do_action( 'updating_jetpack_version', $version, false );
3237
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3238
		}
3239
3240
		self::load_modules();
3241
3242
		Jetpack_Options::delete_option( 'do_activate' );
3243
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3244
	}
3245
3246
	/**
3247
	 * Removes all connection options
3248
	 *
3249
	 * @static
3250
	 */
3251
	public static function plugin_deactivation() {
3252
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3253
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3254
			Jetpack_Network::init()->deactivate();
3255
		} else {
3256
			self::disconnect( false );
3257
			// Jetpack_Heartbeat::init()->deactivate();
3258
		}
3259
	}
3260
3261
	/**
3262
	 * Disconnects from the Jetpack servers.
3263
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3264
	 *
3265
	 * @static
3266
	 */
3267
	public static function disconnect( $update_activated_state = true ) {
3268
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3269
		$connection = self::connection();
3270
		$connection->clean_nonces( true );
3271
3272
		// If the site is in an IDC because sync is not allowed,
3273
		// let's make sure to not disconnect the production site.
3274
		if ( ! self::validate_sync_error_idc_option() ) {
3275
			$tracking = new Tracking();
3276
			$tracking->record_user_event( 'disconnect_site', array() );
3277
3278
			$connection->disconnect_site_wpcom();
3279
		}
3280
3281
		$connection->delete_all_connection_tokens();
3282
		Jetpack_IDC::clear_all_idc_options();
3283
3284
		if ( $update_activated_state ) {
3285
			Jetpack_Options::update_option( 'activated', 4 );
3286
		}
3287
3288
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3289
			// Check then record unique disconnection if site has never been disconnected previously
3290
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3291
				$jetpack_unique_connection['disconnected'] = 1;
3292
			} else {
3293
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3294
					// track unique disconnect
3295
					$jetpack = self::init();
3296
3297
					$jetpack->stat( 'connections', 'unique-disconnect' );
3298
					$jetpack->do_stats( 'server_side' );
3299
				}
3300
				// increment number of times disconnected
3301
				$jetpack_unique_connection['disconnected'] += 1;
3302
			}
3303
3304
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3305
		}
3306
3307
		// Delete all the sync related data. Since it could be taking up space.
3308
		Sender::get_instance()->uninstall();
3309
3310
		// Disable the Heartbeat cron
3311
		Jetpack_Heartbeat::init()->deactivate();
3312
	}
3313
3314
	/**
3315
	 * Unlinks the current user from the linked WordPress.com user.
3316
	 *
3317
	 * @deprecated since 7.7
3318
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3319
	 *
3320
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|null?

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

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

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

Loading history...
3321
	 * @return Boolean Whether the disconnection of the user was successful.
3322
	 */
3323
	public static function unlink_user( $user_id = null ) {
3324
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3325
		return Connection_Manager::disconnect_user( $user_id );
3326
	}
3327
3328
	/**
3329
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3330
	 */
3331
	public static function try_registration() {
3332
		$terms_of_service = new Terms_Of_Service();
3333
		// The user has agreed to the TOS at some point by now.
3334
		$terms_of_service->agree();
3335
3336
		// Let's get some testing in beta versions and such.
3337
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3338
			// Before attempting to connect, let's make sure that the domains are viable.
3339
			$domains_to_check = array_unique(
3340
				array(
3341
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3342
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3343
				)
3344
			);
3345
			foreach ( $domains_to_check as $domain ) {
3346
				$result = self::connection()->is_usable_domain( $domain );
3347
				if ( is_wp_error( $result ) ) {
3348
					return $result;
3349
				}
3350
			}
3351
		}
3352
3353
		$result = self::register();
3354
3355
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3356
		if ( ! $result || is_wp_error( $result ) ) {
3357
			return $result;
3358
		} else {
3359
			return true;
3360
		}
3361
	}
3362
3363
	/**
3364
	 * Tracking an internal event log. Try not to put too much chaff in here.
3365
	 *
3366
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3367
	 */
3368
	public static function log( $code, $data = null ) {
3369
		// only grab the latest 200 entries
3370
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3371
3372
		// Append our event to the log
3373
		$log_entry = array(
3374
			'time'    => time(),
3375
			'user_id' => get_current_user_id(),
3376
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3377
			'code'    => $code,
3378
		);
3379
		// Don't bother storing it unless we've got some.
3380
		if ( ! is_null( $data ) ) {
3381
			$log_entry['data'] = $data;
3382
		}
3383
		$log[] = $log_entry;
3384
3385
		// Try add_option first, to make sure it's not autoloaded.
3386
		// @todo: Add an add_option method to Jetpack_Options
3387
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3388
			Jetpack_Options::update_option( 'log', $log );
3389
		}
3390
3391
		/**
3392
		 * Fires when Jetpack logs an internal event.
3393
		 *
3394
		 * @since 3.0.0
3395
		 *
3396
		 * @param array $log_entry {
3397
		 *  Array of details about the log entry.
3398
		 *
3399
		 *  @param string time Time of the event.
3400
		 *  @param int user_id ID of the user who trigerred the event.
3401
		 *  @param int blog_id Jetpack Blog ID.
3402
		 *  @param string code Unique name for the event.
3403
		 *  @param string data Data about the event.
3404
		 * }
3405
		 */
3406
		do_action( 'jetpack_log_entry', $log_entry );
3407
	}
3408
3409
	/**
3410
	 * Get the internal event log.
3411
	 *
3412
	 * @param $event (string) - only return the specific log events
3413
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3414
	 *
3415
	 * @return array of log events || WP_Error for invalid params
3416
	 */
3417
	public static function get_log( $event = false, $num = false ) {
3418
		if ( $event && ! is_string( $event ) ) {
3419
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with __('First param must be ...g or empty', 'jetpack').

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

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

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

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

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

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

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

Loading history...
3424
		}
3425
3426
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3427
3428
		// If nothing set - act as it did before, otherwise let's start customizing the output
3429
		if ( ! $num && ! $event ) {
3430
			return $entire_log;
3431
		} else {
3432
			$entire_log = array_reverse( $entire_log );
3433
		}
3434
3435
		$custom_log_output = array();
3436
3437
		if ( $event ) {
3438
			foreach ( $entire_log as $log_event ) {
3439
				if ( $event == $log_event['code'] ) {
3440
					$custom_log_output[] = $log_event;
3441
				}
3442
			}
3443
		} else {
3444
			$custom_log_output = $entire_log;
3445
		}
3446
3447
		if ( $num ) {
3448
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3449
		}
3450
3451
		return $custom_log_output;
3452
	}
3453
3454
	/**
3455
	 * Log modification of important settings.
3456
	 */
3457
	public static function log_settings_change( $option, $old_value, $value ) {
3458
		switch ( $option ) {
3459
			case 'jetpack_sync_non_public_post_stati':
3460
				self::log( $option, $value );
3461
				break;
3462
		}
3463
	}
3464
3465
	/**
3466
	 * Return stat data for WPCOM sync
3467
	 */
3468
	public static function get_stat_data( $encode = true, $extended = true ) {
3469
		$data = Jetpack_Heartbeat::generate_stats_array();
3470
3471
		if ( $extended ) {
3472
			$additional_data = self::get_additional_stat_data();
3473
			$data            = array_merge( $data, $additional_data );
3474
		}
3475
3476
		if ( $encode ) {
3477
			return json_encode( $data );
3478
		}
3479
3480
		return $data;
3481
	}
3482
3483
	/**
3484
	 * Get additional stat data to sync to WPCOM
3485
	 */
3486
	public static function get_additional_stat_data( $prefix = '' ) {
3487
		$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...
3488
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3489
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3490
		$return[ "{$prefix}site-count" ]    = 0;
3491
3492
		if ( function_exists( 'get_blog_count' ) ) {
3493
			$return[ "{$prefix}site-count" ] = get_blog_count();
3494
		}
3495
		return $return;
3496
	}
3497
3498
	private static function get_site_user_count() {
3499
		global $wpdb;
3500
3501
		if ( function_exists( 'wp_is_large_network' ) ) {
3502
			if ( wp_is_large_network( 'users' ) ) {
3503
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3504
			}
3505
		}
3506
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3507
			// It wasn't there, so regenerate the data and save the transient
3508
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3509
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3510
		}
3511
		return $user_count;
3512
	}
3513
3514
	/* Admin Pages */
3515
3516
	function admin_init() {
3517
		// If the plugin is not connected, display a connect message.
3518
		if (
3519
			// the plugin was auto-activated and needs its candy
3520
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3521
		||
3522
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3523
			! Jetpack_Options::get_option( 'activated' )
3524
		) {
3525
			self::plugin_initialize();
3526
		}
3527
3528
		$is_development_mode = ( new Status() )->is_development_mode();
3529
		if ( ! self::is_active() && ! $is_development_mode ) {
3530
			Jetpack_Connection_Banner::init();
3531
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3532
			// Upgrade: 1.1 -> 1.1.1
3533
			// Check and see if host can verify the Jetpack servers' SSL certificate
3534
			$args       = array();
3535
			$connection = self::connection();
3536
			Client::_wp_remote_request(
3537
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3538
				$args,
3539
				true
3540
			);
3541
		}
3542
3543
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3544
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3545
		}
3546
3547
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3548
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3549
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3550
3551
		if ( self::is_active() || $is_development_mode ) {
3552
			// Artificially throw errors in certain whitelisted cases during plugin activation
3553
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3554
		}
3555
3556
		// Add custom column in wp-admin/users.php to show whether user is linked.
3557
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3558
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3559
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3560
	}
3561
3562
	function admin_body_class( $admin_body_class = '' ) {
3563
		$classes = explode( ' ', trim( $admin_body_class ) );
3564
3565
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3566
3567
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3568
		return " $admin_body_class ";
3569
	}
3570
3571
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3572
		return $admin_body_class . ' jetpack-pagestyles ';
3573
	}
3574
3575
	/**
3576
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3577
	 * This function artificially throws errors for such cases (whitelisted).
3578
	 *
3579
	 * @param string $plugin The activated plugin.
3580
	 */
3581
	function throw_error_on_activate_plugin( $plugin ) {
3582
		$active_modules = self::get_active_modules();
3583
3584
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3585
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3586
			$throw = false;
3587
3588
			// Try and make sure it really was the stats plugin
3589
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3590
				if ( 'stats.php' == basename( $plugin ) ) {
3591
					$throw = true;
3592
				}
3593
			} else {
3594
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3595
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3596
					$throw = true;
3597
				}
3598
			}
3599
3600
			if ( $throw ) {
3601
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3602
			}
3603
		}
3604
	}
3605
3606
	function intercept_plugin_error_scrape_init() {
3607
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3608
	}
3609
3610
	function intercept_plugin_error_scrape( $action, $result ) {
3611
		if ( ! $result ) {
3612
			return;
3613
		}
3614
3615
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3616
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3617
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3618
			}
3619
		}
3620
	}
3621
3622
	/**
3623
	 * Register the remote file upload request handlers, if needed.
3624
	 *
3625
	 * @access public
3626
	 */
3627
	public function add_remote_request_handlers() {
3628
		// Remote file uploads are allowed only via AJAX requests.
3629
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3630
			return;
3631
		}
3632
3633
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3634
		$remote_request_actions = array(
3635
			'jetpack_upload_file',
3636
			'jetpack_update_file',
3637
		);
3638
3639
		// phpcs:ignore WordPress.Security.NonceVerification
3640
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3641
			return;
3642
		}
3643
3644
		// Require Jetpack authentication for the remote file upload AJAX requests.
3645
		$this->connection_manager->require_jetpack_authentication();
3646
3647
		// Register the remote file upload AJAX handlers.
3648
		foreach ( $remote_request_actions as $action ) {
3649
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3650
		}
3651
	}
3652
3653
	/**
3654
	 * Handler for Jetpack remote file uploads.
3655
	 *
3656
	 * @access public
3657
	 */
3658
	public function remote_request_handlers() {
3659
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

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

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

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

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

Loading history...
3660
3661
		switch ( current_filter() ) {
3662
			case 'wp_ajax_nopriv_jetpack_upload_file':
3663
				$response = $this->upload_handler();
3664
				break;
3665
3666
			case 'wp_ajax_nopriv_jetpack_update_file':
3667
				$response = $this->upload_handler( true );
3668
				break;
3669
			default:
3670
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_handler'.

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

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

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

Loading history...
3671
				break;
3672
		}
3673
3674
		if ( ! $response ) {
3675
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_error'.

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

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

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

Loading history...
3676
		}
3677
3678
		if ( is_wp_error( $response ) ) {
3679
			$status_code       = $response->get_error_data();
0 ignored issues
show
Bug introduced by
The method get_error_data() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3680
			$error             = $response->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3681
			$error_description = $response->get_error_message();
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3682
3683
			if ( ! is_int( $status_code ) ) {
3684
				$status_code = 400;
3685
			}
3686
3687
			status_header( $status_code );
3688
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3689
		}
3690
3691
		status_header( 200 );
3692
		if ( true === $response ) {
3693
			exit;
3694
		}
3695
3696
		die( json_encode( (object) $response ) );
3697
	}
3698
3699
	/**
3700
	 * Uploads a file gotten from the global $_FILES.
3701
	 * If `$update_media_item` is true and `post_id` is defined
3702
	 * the attachment file of the media item (gotten through of the post_id)
3703
	 * will be updated instead of add a new one.
3704
	 *
3705
	 * @param  boolean $update_media_item - update media attachment
3706
	 * @return array - An array describing the uploadind files process
3707
	 */
3708
	function upload_handler( $update_media_item = false ) {
3709
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3710
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 405.

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

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

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

Loading history...
3711
		}
3712
3713
		$user = wp_authenticate( '', '' );
3714
		if ( ! $user || is_wp_error( $user ) ) {
3715
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 403.

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

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

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

Loading history...
3716
		}
3717
3718
		wp_set_current_user( $user->ID );
3719
3720
		if ( ! current_user_can( 'upload_files' ) ) {
3721
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'cannot_upload_files'.

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

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

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

Loading history...
3722
		}
3723
3724
		if ( empty( $_FILES ) ) {
3725
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'no_files_uploaded'.

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

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

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

Loading history...
3726
		}
3727
3728
		foreach ( array_keys( $_FILES ) as $files_key ) {
3729
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3730
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'missing_hmac'.

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

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

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

Loading history...
3731
			}
3732
		}
3733
3734
		$media_keys = array_keys( $_FILES['media'] );
3735
3736
		$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...
3737
		if ( ! $token || is_wp_error( $token ) ) {
3738
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_token'.

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

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

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

Loading history...
3739
		}
3740
3741
		$uploaded_files = array();
3742
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3743
		unset( $GLOBALS['post'] );
3744
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3745
			$file = array();
3746
			foreach ( $media_keys as $media_key ) {
3747
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3748
			}
3749
3750
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3751
3752
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3753
			if ( $hmac_provided !== $hmac_file ) {
3754
				$uploaded_files[ $index ] = (object) array(
3755
					'error'             => 'invalid_hmac',
3756
					'error_description' => 'The corresponding HMAC for this file does not match',
3757
				);
3758
				continue;
3759
			}
3760
3761
			$_FILES['.jetpack.upload.'] = $file;
3762
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3763
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3764
				$post_id = 0;
3765
			}
3766
3767
			if ( $update_media_item ) {
3768
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3769
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'invalid_input'.

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

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

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

Loading history...
3770
				}
3771
3772
				$media_array = $_FILES['media'];
3773
3774
				$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...
3775
				$file_array['type']     = $media_array['type'][0];
3776
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3777
				$file_array['error']    = $media_array['error'][0];
3778
				$file_array['size']     = $media_array['size'][0];
3779
3780
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3781
3782
				if ( is_wp_error( $edited_media_item ) ) {
3783
					return $edited_media_item;
3784
				}
3785
3786
				$response = (object) array(
3787
					'id'   => (string) $post_id,
3788
					'file' => (string) $edited_media_item->post_title,
3789
					'url'  => (string) wp_get_attachment_url( $post_id ),
3790
					'type' => (string) $edited_media_item->post_mime_type,
3791
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3792
				);
3793
3794
				return (array) array( $response );
3795
			}
3796
3797
			$attachment_id = media_handle_upload(
3798
				'.jetpack.upload.',
3799
				$post_id,
3800
				array(),
3801
				array(
3802
					'action' => 'jetpack_upload_file',
3803
				)
3804
			);
3805
3806
			if ( ! $attachment_id ) {
3807
				$uploaded_files[ $index ] = (object) array(
3808
					'error'             => 'unknown',
3809
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3810
				);
3811
			} elseif ( is_wp_error( $attachment_id ) ) {
3812
				$uploaded_files[ $index ] = (object) array(
3813
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3814
					'error_description' => $attachment_id->get_error_message(),
3815
				);
3816
			} else {
3817
				$attachment               = get_post( $attachment_id );
3818
				$uploaded_files[ $index ] = (object) array(
3819
					'id'   => (string) $attachment_id,
3820
					'file' => $attachment->post_title,
3821
					'url'  => wp_get_attachment_url( $attachment_id ),
3822
					'type' => $attachment->post_mime_type,
3823
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3824
				);
3825
				// Zip files uploads are not supported unless they are done for installation purposed
3826
				// lets delete them in case something goes wrong in this whole process
3827
				if ( 'application/zip' === $attachment->post_mime_type ) {
3828
					// Schedule a cleanup for 2 hours from now in case of failed install.
3829
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3830
				}
3831
			}
3832
		}
3833
		if ( ! is_null( $global_post ) ) {
3834
			$GLOBALS['post'] = $global_post;
3835
		}
3836
3837
		return $uploaded_files;
3838
	}
3839
3840
	/**
3841
	 * Add help to the Jetpack page
3842
	 *
3843
	 * @since Jetpack (1.2.3)
3844
	 * @return false if not the Jetpack page
3845
	 */
3846
	function admin_help() {
3847
		$current_screen = get_current_screen();
3848
3849
		// Overview
3850
		$current_screen->add_help_tab(
3851
			array(
3852
				'id'      => 'home',
3853
				'title'   => __( 'Home', 'jetpack' ),
3854
				'content' =>
3855
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3856
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3857
					'<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>',
3858
			)
3859
		);
3860
3861
		// Screen Content
3862
		if ( current_user_can( 'manage_options' ) ) {
3863
			$current_screen->add_help_tab(
3864
				array(
3865
					'id'      => 'settings',
3866
					'title'   => __( 'Settings', 'jetpack' ),
3867
					'content' =>
3868
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3869
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3870
						'<ol>' .
3871
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3872
							'<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>' .
3873
						'</ol>' .
3874
						'<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>',
3875
				)
3876
			);
3877
		}
3878
3879
		// Help Sidebar
3880
		$current_screen->set_help_sidebar(
3881
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3882
			'<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3883
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3884
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3885
		);
3886
	}
3887
3888
	function admin_menu_css() {
3889
		wp_enqueue_style( 'jetpack-icons' );
3890
	}
3891
3892
	function admin_menu_order() {
3893
		return true;
3894
	}
3895
3896 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3897
		$jp_menu_order = array();
3898
3899
		foreach ( $menu_order as $index => $item ) {
3900
			if ( $item != 'jetpack' ) {
3901
				$jp_menu_order[] = $item;
3902
			}
3903
3904
			if ( $index == 0 ) {
3905
				$jp_menu_order[] = 'jetpack';
3906
			}
3907
		}
3908
3909
		return $jp_menu_order;
3910
	}
3911
3912
	function admin_banner_styles() {
3913
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3914
3915 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3916
			wp_register_style(
3917
				'jetpack-dops-style',
3918
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3919
				array(),
3920
				JETPACK__VERSION
3921
			);
3922
		}
3923
3924
		wp_enqueue_style(
3925
			'jetpack',
3926
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3927
			array( 'jetpack-dops-style' ),
3928
			JETPACK__VERSION . '-20121016'
3929
		);
3930
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3931
		wp_style_add_data( 'jetpack', 'suffix', $min );
3932
	}
3933
3934
	function plugin_action_links( $actions ) {
3935
3936
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3937
3938
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
3939
			return array_merge(
3940
				$jetpack_home,
3941
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3942
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3943
				$actions
3944
			);
3945
		}
3946
3947
		return array_merge( $jetpack_home, $actions );
3948
	}
3949
3950
	/*
3951
	 * Registration flow:
3952
	 * 1 - ::admin_page_load() action=register
3953
	 * 2 - ::try_registration()
3954
	 * 3 - ::register()
3955
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3956
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3957
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3958
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3959
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3960
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3961
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3962
	 *       jetpack_id, jetpack_secret, jetpack_public
3963
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3964
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3965
	 * 5 - user logs in with WP.com account
3966
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3967
	 *		- Manager::authorize()
3968
	 *		- Manager::get_token()
3969
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3970
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3971
	 *			- which responds with access_token, token_type, scope
3972
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
3973
	 *		- Jetpack::activate_default_modules()
3974
	 *     		- Deactivates deprecated plugins
3975
	 *     		- Activates all default modules
3976
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3977
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3978
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3979
	 *     Done!
3980
	 */
3981
3982
	/**
3983
	 * Handles the page load events for the Jetpack admin page
3984
	 */
3985
	function admin_page_load() {
3986
		$error = false;
3987
3988
		// Make sure we have the right body class to hook stylings for subpages off of.
3989
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
3990
3991
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3992
			// Should only be used in intermediate redirects to preserve state across redirects
3993
			self::restate();
3994
		}
3995
3996
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3997
			// @todo: Add validation against a known whitelist
3998
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
3999
			// User clicked in the iframe to link their accounts
4000
			if ( ! self::is_user_connected() ) {
4001
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4002
4003
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4004
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4005
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4006
4007
				if ( isset( $_GET['notes_iframe'] ) ) {
4008
					$connect_url .= '&notes_iframe';
4009
				}
4010
				wp_redirect( $connect_url );
4011
				exit;
4012
			} else {
4013
				if ( ! isset( $_GET['calypso_env'] ) ) {
4014
					self::state( 'message', 'already_authorized' );
4015
					wp_safe_redirect( self::admin_url() );
4016
					exit;
4017
				} else {
4018
					$connect_url  = $this->build_connect_url( true, false, $from );
4019
					$connect_url .= '&already_authorized=true';
4020
					wp_redirect( $connect_url );
4021
					exit;
4022
				}
4023
			}
4024
		}
4025
4026
		if ( isset( $_GET['action'] ) ) {
4027
			switch ( $_GET['action'] ) {
4028
				case 'authorize':
4029
					if ( self::is_active() && self::is_user_connected() ) {
4030
						self::state( 'message', 'already_authorized' );
4031
						wp_safe_redirect( self::admin_url() );
4032
						exit;
4033
					}
4034
					self::log( 'authorize' );
4035
					$client_server = new Jetpack_Client_Server();
4036
					$client_server->client_authorize();
4037
					exit;
4038
				case 'register':
4039
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4040
						$error = 'cheatin';
4041
						break;
4042
					}
4043
					check_admin_referer( 'jetpack-register' );
4044
					self::log( 'register' );
4045
					self::maybe_set_version_option();
4046
					$registered = self::try_registration();
4047
					if ( is_wp_error( $registered ) ) {
4048
						$error = $registered->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4049
						self::state( 'error', $error );
4050
						self::state( 'error', $registered->get_error_message() );
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4051
4052
						/**
4053
						 * Jetpack registration Error.
4054
						 *
4055
						 * @since 7.5.0
4056
						 *
4057
						 * @param string|int $error The error code.
4058
						 * @param \WP_Error $registered The error object.
4059
						 */
4060
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4061
						break;
4062
					}
4063
4064
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4065
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4066
4067
					/**
4068
					 * Jetpack registration Success.
4069
					 *
4070
					 * @since 7.5.0
4071
					 *
4072
					 * @param string $from 'from' GET parameter;
4073
					 */
4074
					do_action( 'jetpack_connection_register_success', $from );
4075
4076
					$url = $this->build_connect_url( true, $redirect, $from );
4077
4078
					if ( ! empty( $_GET['onboarding'] ) ) {
4079
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4080
					}
4081
4082
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4083
						$url = add_query_arg( 'auth_approved', 'true', $url );
4084
					}
4085
4086
					wp_redirect( $url );
4087
					exit;
4088
				case 'activate':
4089
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4090
						$error = 'cheatin';
4091
						break;
4092
					}
4093
4094
					$module = stripslashes( $_GET['module'] );
4095
					check_admin_referer( "jetpack_activate-$module" );
4096
					self::log( 'activate', $module );
4097
					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...
4098
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4099
					}
4100
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4101
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4102
					exit;
4103
				case 'activate_default_modules':
4104
					check_admin_referer( 'activate_default_modules' );
4105
					self::log( 'activate_default_modules' );
4106
					self::restate();
4107
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4108
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4109
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4110
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4111
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4112
					exit;
4113
				case 'disconnect':
4114
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4115
						$error = 'cheatin';
4116
						break;
4117
					}
4118
4119
					check_admin_referer( 'jetpack-disconnect' );
4120
					self::log( 'disconnect' );
4121
					self::disconnect();
4122
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4123
					exit;
4124
				case 'reconnect':
4125
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4126
						$error = 'cheatin';
4127
						break;
4128
					}
4129
4130
					check_admin_referer( 'jetpack-reconnect' );
4131
					self::log( 'reconnect' );
4132
					$this->disconnect();
4133
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4134
					exit;
4135 View Code Duplication
				case 'deactivate':
4136
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4137
						$error = 'cheatin';
4138
						break;
4139
					}
4140
4141
					$modules = stripslashes( $_GET['module'] );
4142
					check_admin_referer( "jetpack_deactivate-$modules" );
4143
					foreach ( explode( ',', $modules ) as $module ) {
4144
						self::log( 'deactivate', $module );
4145
						self::deactivate_module( $module );
4146
						self::state( 'message', 'module_deactivated' );
4147
					}
4148
					self::state( 'module', $modules );
4149
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4150
					exit;
4151
				case 'unlink':
4152
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4153
					check_admin_referer( 'jetpack-unlink' );
4154
					self::log( 'unlink' );
4155
					Connection_Manager::disconnect_user();
4156
					self::state( 'message', 'unlinked' );
4157
					if ( 'sub-unlink' == $redirect ) {
4158
						wp_safe_redirect( admin_url() );
4159
					} else {
4160
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4161
					}
4162
					exit;
4163
				case 'onboard':
4164
					if ( ! current_user_can( 'manage_options' ) ) {
4165
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4166
					} else {
4167
						self::create_onboarding_token();
4168
						$url = $this->build_connect_url( true );
4169
4170
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4171
							$url = add_query_arg( 'onboarding', $token, $url );
4172
						}
4173
4174
						$calypso_env = $this->get_calypso_env();
4175
						if ( ! empty( $calypso_env ) ) {
4176
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4177
						}
4178
4179
						wp_redirect( $url );
4180
						exit;
4181
					}
4182
					exit;
4183
				default:
4184
					/**
4185
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4186
					 *
4187
					 * @since 2.6.0
4188
					 *
4189
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4190
					 */
4191
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4192
			}
4193
		}
4194
4195
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4196
			self::activate_new_modules( true );
4197
		}
4198
4199
		$message_code = self::state( 'message' );
4200
		if ( self::state( 'optin-manage' ) ) {
4201
			$activated_manage = $message_code;
4202
			$message_code     = 'jetpack-manage';
4203
		}
4204
4205
		switch ( $message_code ) {
4206
			case 'jetpack-manage':
4207
				$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>';
4208
				if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4209
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4210
				}
4211
				break;
4212
4213
		}
4214
4215
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4216
4217
		if ( ! empty( $deactivated_plugins ) ) {
4218
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4219
			$deactivated_titles  = array();
4220
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4221
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4222
					continue;
4223
				}
4224
4225
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4226
			}
4227
4228
			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...
4229
				if ( $this->message ) {
4230
					$this->message .= "<br /><br />\n";
4231
				}
4232
4233
				$this->message .= wp_sprintf(
4234
					_n(
4235
						'Jetpack contains the most recent version of the old %l plugin.',
4236
						'Jetpack contains the most recent versions of the old %l plugins.',
4237
						count( $deactivated_titles ),
4238
						'jetpack'
4239
					),
4240
					$deactivated_titles
4241
				);
4242
4243
				$this->message .= "<br />\n";
4244
4245
				$this->message .= _n(
4246
					'The old version has been deactivated and can be removed from your site.',
4247
					'The old versions have been deactivated and can be removed from your site.',
4248
					count( $deactivated_titles ),
4249
					'jetpack'
4250
				);
4251
			}
4252
		}
4253
4254
		$this->privacy_checks = self::state( 'privacy_checks' );
4255
4256
		if ( $this->message || $this->error || $this->privacy_checks ) {
4257
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4258
		}
4259
4260
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4261
	}
4262
4263
	function admin_notices() {
4264
4265
		if ( $this->error ) {
4266
			?>
4267
<div id="message" class="jetpack-message jetpack-err">
4268
	<div class="squeezer">
4269
		<h2>
4270
			<?php
4271
			echo wp_kses(
4272
				$this->error,
4273
				array(
4274
					'a'      => array( 'href' => array() ),
4275
					'small'  => true,
4276
					'code'   => true,
4277
					'strong' => true,
4278
					'br'     => true,
4279
					'b'      => true,
4280
				)
4281
			);
4282
			?>
4283
			</h2>
4284
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4285
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4286
<?php	endif; ?>
4287
	</div>
4288
</div>
4289
			<?php
4290
		}
4291
4292
		if ( $this->message ) {
4293
			?>
4294
<div id="message" class="jetpack-message">
4295
	<div class="squeezer">
4296
		<h2>
4297
			<?php
4298
			echo wp_kses(
4299
				$this->message,
4300
				array(
4301
					'strong' => array(),
4302
					'a'      => array( 'href' => true ),
4303
					'br'     => true,
4304
				)
4305
			);
4306
			?>
4307
			</h2>
4308
	</div>
4309
</div>
4310
			<?php
4311
		}
4312
4313
		if ( $this->privacy_checks ) :
4314
			$module_names = $module_slugs = array();
4315
4316
			$privacy_checks = explode( ',', $this->privacy_checks );
4317
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4318
			foreach ( $privacy_checks as $module_slug ) {
4319
				$module = self::get_module( $module_slug );
4320
				if ( ! $module ) {
4321
					continue;
4322
				}
4323
4324
				$module_slugs[] = $module_slug;
4325
				$module_names[] = "<strong>{$module['name']}</strong>";
4326
			}
4327
4328
			$module_slugs = join( ',', $module_slugs );
4329
			?>
4330
<div id="message" class="jetpack-message jetpack-err">
4331
	<div class="squeezer">
4332
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4333
		<p>
4334
			<?php
4335
			echo wp_kses(
4336
				wptexturize(
4337
					wp_sprintf(
4338
						_nx(
4339
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4340
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4341
							count( $privacy_checks ),
4342
							'%l = list of Jetpack module/feature names',
4343
							'jetpack'
4344
						),
4345
						$module_names
4346
					)
4347
				),
4348
				array( 'strong' => true )
4349
			);
4350
4351
			echo "\n<br />\n";
4352
4353
			echo wp_kses(
4354
				sprintf(
4355
					_nx(
4356
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4357
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4358
						count( $privacy_checks ),
4359
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4360
						'jetpack'
4361
					),
4362
					wp_nonce_url(
4363
						self::admin_url(
4364
							array(
4365
								'page'   => 'jetpack',
4366
								'action' => 'deactivate',
4367
								'module' => urlencode( $module_slugs ),
4368
							)
4369
						),
4370
						"jetpack_deactivate-$module_slugs"
4371
					),
4372
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4373
				),
4374
				array(
4375
					'a' => array(
4376
						'href'  => true,
4377
						'title' => true,
4378
					),
4379
				)
4380
			);
4381
			?>
4382
		</p>
4383
	</div>
4384
</div>
4385
			<?php
4386
endif;
4387
	}
4388
4389
	/**
4390
	 * We can't always respond to a signed XML-RPC request with a
4391
	 * helpful error message. In some circumstances, doing so could
4392
	 * leak information.
4393
	 *
4394
	 * Instead, track that the error occurred via a Jetpack_Option,
4395
	 * and send that data back in the heartbeat.
4396
	 * All this does is increment a number, but it's enough to find
4397
	 * trends.
4398
	 *
4399
	 * @param WP_Error $xmlrpc_error The error produced during
4400
	 *                               signature validation.
4401
	 */
4402
	function track_xmlrpc_error( $xmlrpc_error ) {
4403
		$code = is_wp_error( $xmlrpc_error )
4404
			? $xmlrpc_error->get_error_code()
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4405
			: 'should-not-happen';
4406
4407
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4408
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4409
			// No need to update the option if we already have
4410
			// this code stored.
4411
			return;
4412
		}
4413
		$xmlrpc_errors[ $code ] = true;
4414
4415
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4416
	}
4417
4418
	/**
4419
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4420
	 */
4421
	function stat( $group, $detail ) {
4422
		if ( ! isset( $this->stats[ $group ] ) ) {
4423
			$this->stats[ $group ] = array();
4424
		}
4425
		$this->stats[ $group ][] = $detail;
4426
	}
4427
4428
	/**
4429
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4430
	 */
4431
	function do_stats( $method = '' ) {
4432
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4433
			foreach ( $this->stats as $group => $stats ) {
4434
				if ( is_array( $stats ) && count( $stats ) ) {
4435
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4436
					if ( 'server_side' === $method ) {
4437
						self::do_server_side_stat( $args );
4438
					} else {
4439
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4440
					}
4441
				}
4442
				unset( $this->stats[ $group ] );
4443
			}
4444
		}
4445
	}
4446
4447
	/**
4448
	 * Runs stats code for a one-off, server-side.
4449
	 *
4450
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4451
	 *
4452
	 * @return bool If it worked.
4453
	 */
4454
	static function do_server_side_stat( $args ) {
4455
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4456
		if ( is_wp_error( $response ) ) {
4457
			return false;
4458
		}
4459
4460
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4461
			return false;
4462
		}
4463
4464
		return true;
4465
	}
4466
4467
	/**
4468
	 * Builds the stats url.
4469
	 *
4470
	 * @param $args array|string The arguments to append to the URL.
4471
	 *
4472
	 * @return string The URL to be pinged.
4473
	 */
4474
	static function build_stats_url( $args ) {
4475
		$defaults = array(
4476
			'v'    => 'wpcom2',
4477
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4478
		);
4479
		$args     = wp_parse_args( $args, $defaults );
4480
		/**
4481
		 * Filter the URL used as the Stats tracking pixel.
4482
		 *
4483
		 * @since 2.3.2
4484
		 *
4485
		 * @param string $url Base URL used as the Stats tracking pixel.
4486
		 */
4487
		$base_url = apply_filters(
4488
			'jetpack_stats_base_url',
4489
			'https://pixel.wp.com/g.gif'
4490
		);
4491
		$url      = add_query_arg( $args, $base_url );
4492
		return $url;
4493
	}
4494
4495
	/**
4496
	 * Get the role of the current user.
4497
	 *
4498
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4499
	 *
4500
	 * @access public
4501
	 * @static
4502
	 *
4503
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4504
	 */
4505
	public static function translate_current_user_to_role() {
4506
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4507
4508
		$roles = new Roles();
4509
		return $roles->translate_current_user_to_role();
4510
	}
4511
4512
	/**
4513
	 * Get the role of a particular user.
4514
	 *
4515
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4516
	 *
4517
	 * @access public
4518
	 * @static
4519
	 *
4520
	 * @param \WP_User $user User object.
4521
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4522
	 */
4523
	public static function translate_user_to_role( $user ) {
4524
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4525
4526
		$roles = new Roles();
4527
		return $roles->translate_user_to_role( $user );
4528
	}
4529
4530
	/**
4531
	 * Get the minimum capability for a role.
4532
	 *
4533
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4534
	 *
4535
	 * @access public
4536
	 * @static
4537
	 *
4538
	 * @param string $role Role name.
4539
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4540
	 */
4541
	public static function translate_role_to_cap( $role ) {
4542
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4543
4544
		$roles = new Roles();
4545
		return $roles->translate_role_to_cap( $role );
4546
	}
4547
4548
	/**
4549
	 * Sign a user role with the master access token.
4550
	 * If not specified, will default to the current user.
4551
	 *
4552
	 * @deprecated since 7.7
4553
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4554
	 *
4555
	 * @access public
4556
	 * @static
4557
	 *
4558
	 * @param string $role    User role.
4559
	 * @param int    $user_id ID of the user.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|null?

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

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

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

Loading history...
4560
	 * @return string Signed user role.
4561
	 */
4562
	public static function sign_role( $role, $user_id = null ) {
4563
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4564
		return self::connection()->sign_role( $role, $user_id );
4565
	}
4566
4567
	/**
4568
	 * Builds a URL to the Jetpack connection auth page
4569
	 *
4570
	 * @since 3.9.5
4571
	 *
4572
	 * @param bool        $raw If true, URL will not be escaped.
4573
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4574
	 *                              If string, will be a custom redirect.
4575
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4576
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4577
	 *
4578
	 * @return string Connect URL
4579
	 */
4580
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4581
		$site_id    = Jetpack_Options::get_option( 'id' );
4582
		$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...
4583
4584
		if ( $register || ! $blog_token || ! $site_id ) {
4585
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4586
4587
			if ( ! empty( $redirect ) ) {
4588
				$url = add_query_arg(
4589
					'redirect',
4590
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4591
					$url
4592
				);
4593
			}
4594
4595
			if ( is_network_admin() ) {
4596
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4597
			}
4598
4599
			$calypso_env = self::get_calypso_env();
4600
4601
			if ( ! empty( $calypso_env ) ) {
4602
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4603
			}
4604
		} else {
4605
4606
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4607
			// because otherwise this logic can get us in to a loop.
4608
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4609
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4610
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4611
4612
				$response = Client::wpcom_json_api_request_as_blog(
4613
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4614
					'1.1'
4615
				);
4616
4617
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4618
4619
					// Generating a register URL instead to refresh the existing token
4620
					return $this->build_connect_url( $raw, $redirect, $from, true );
4621
				}
4622
			}
4623
4624
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4580 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...
4625
		}
4626
4627
		if ( $from ) {
4628
			$url = add_query_arg( 'from', $from, $url );
4629
		}
4630
4631
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4632
		/**
4633
		 * Filter the URL used when connecting a user to a WordPress.com account.
4634
		 *
4635
		 * @since 8.1.0
4636
		 *
4637
		 * @param string $url Connection URL.
4638
		 * @param bool   $raw If true, URL will not be escaped.
4639
		 */
4640
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4641
	}
4642
4643
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4644
4645
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4646
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4647
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4648
4649
		if ( $iframe ) {
4650
			add_filter( 'jetpack_api_url', array( __CLASS__, 'filter_connect_api_iframe_url' ), 10, 2 );
4651
		}
4652
4653
		$c8n = self::connection();
4654
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
0 ignored issues
show
Documentation introduced by
$redirect is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4655
4656
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4657
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4658
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4659
4660
		if ( $iframe ) {
4661
			remove_filter( 'jetpack_api_url', array( __CLASS__, 'filter_connect_api_iframe_url' ) );
4662
		}
4663
4664
		return $url;
4665
	}
4666
4667
	/**
4668
	 * Filters the connection URL parameter array.
4669
	 *
4670
	 * @param Array $args default URL parameters used by the package.
4671
	 * @return Array the modified URL arguments array.
4672
	 */
4673
	public static function filter_connect_request_body( $args ) {
4674
		if (
4675
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4676
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4677
		) {
4678
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4679
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4680
				? $gp_locale->slug
4681
				: '';
4682
		}
4683
4684
		$tracking        = new Tracking();
4685
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4686
4687
		$args = array_merge(
4688
			$args,
4689
			array(
4690
				'_ui' => $tracks_identity['_ui'],
4691
				'_ut' => $tracks_identity['_ut'],
4692
			)
4693
		);
4694
4695
		$calypso_env = self::get_calypso_env();
4696
4697
		if ( ! empty( $calypso_env ) ) {
4698
			$args['calypso_env'] = $calypso_env;
4699
		}
4700
4701
		return $args;
4702
	}
4703
4704
	/**
4705
	 * Filters the URL that will process the connection data. It can be different from the URL
4706
	 * that we send the user to after everything is done.
4707
	 *
4708
	 * @param String $processing_url the default redirect URL used by the package.
4709
	 * @return String the modified URL.
4710
	 */
4711
	public static function filter_connect_processing_url( $processing_url ) {
4712
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4713
		return $processing_url;
4714
	}
4715
4716
	/**
4717
	 * Filters the redirection URL that is used for connect requests. The redirect
4718
	 * URL should return the user back to the Jetpack console.
4719
	 *
4720
	 * @param String $redirect the default redirect URL used by the package.
4721
	 * @return String the modified URL.
4722
	 */
4723
	public static function filter_connect_redirect_url( $redirect ) {
4724
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4725
		$redirect           = $redirect
4726
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4727
			: $jetpack_admin_page;
4728
4729
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4730
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4731
		}
4732
4733
		return $redirect;
4734
	}
4735
4736
	/**
4737
	 * Filters the API URL that is used for connect requests. The method
4738
	 * intercepts only the authorize URL and replaces it with another if needed.
4739
	 *
4740
	 * @param String $api_url the default redirect API URL used by the package.
4741
	 * @param String $relative_url the path of the URL that's being used.
4742
	 * @return String the modified URL.
4743
	 */
4744
	public static function filter_connect_api_iframe_url( $api_url, $relative_url ) {
4745
4746
		// Short-circuit on anything that is not related to connect requests.
4747
		if ( 'authorize' !== $relative_url ) {
4748
			return $api_url;
4749
		}
4750
4751
		$c8n = self::connection();
4752
4753
		return $c8n->api_url( 'authorize_iframe' );
4754
	}
4755
4756
	/**
4757
	 * This action fires at the beginning of the Manager::authorize method.
4758
	 */
4759
	public static function authorize_starting() {
4760
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4761
		// Checking if site has been active/connected previously before recording unique connection.
4762
		if ( ! $jetpack_unique_connection ) {
4763
			// jetpack_unique_connection option has never been set.
4764
			$jetpack_unique_connection = array(
4765
				'connected'    => 0,
4766
				'disconnected' => 0,
4767
				'version'      => '3.6.1',
4768
			);
4769
4770
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4771
4772
			// Track unique connection.
4773
			$jetpack = self::init();
4774
4775
			$jetpack->stat( 'connections', 'unique-connection' );
4776
			$jetpack->do_stats( 'server_side' );
4777
		}
4778
4779
		// Increment number of times connected.
4780
		$jetpack_unique_connection['connected'] += 1;
4781
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4782
	}
4783
4784
	/**
4785
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4786
	 * linked.
4787
	 */
4788
	public static function authorize_ending_linked() {
4789
		// Don't activate anything since we are just connecting a user.
4790
		self::state( 'message', 'linked' );
4791
	}
4792
4793
	/**
4794
	 * This action fires at the end of the Manager::authorize method when the master user is
4795
	 * authorized.
4796
	 *
4797
	 * @param array $data The request data.
4798
	 */
4799
	public static function authorize_ending_authorized( $data ) {
4800
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4801
		self::invalidate_onboarding_token();
4802
4803
		// If redirect_uri is SSO, ensure SSO module is enabled.
4804
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
4805
4806
		/** This filter is documented in class.jetpack-cli.php */
4807
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4808
4809
		$activate_sso = (
4810
			isset( $redirect_options['action'] ) &&
4811
			'jetpack-sso' === $redirect_options['action'] &&
4812
			$jetpack_start_enable_sso
4813
		);
4814
4815
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4816
4817
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4818
	}
4819
4820
	/**
4821
	 * Get our assumed site creation date.
4822
	 * Calculated based on the earlier date of either:
4823
	 * - Earliest admin user registration date.
4824
	 * - Earliest date of post of any post type.
4825
	 *
4826
	 * @since 7.2.0
4827
	 * @deprecated since 7.8.0
4828
	 *
4829
	 * @return string Assumed site creation date and time.
4830
	 */
4831
	public static function get_assumed_site_creation_date() {
4832
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4833
		return self::connection()->get_assumed_site_creation_date();
4834
	}
4835
4836 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4837
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4838
4839
		if ( $activation_source_name ) {
4840
			$args['_as'] = urlencode( $activation_source_name );
4841
		}
4842
4843
		if ( $activation_source_keyword ) {
4844
			$args['_ak'] = urlencode( $activation_source_keyword );
4845
		}
4846
	}
4847
4848
	function build_reconnect_url( $raw = false ) {
4849
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4850
		return $raw ? $url : esc_url( $url );
4851
	}
4852
4853
	public static function admin_url( $args = null ) {
4854
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4855
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4856
		return $url;
4857
	}
4858
4859
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4860
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4861
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4862
	}
4863
4864
	function dismiss_jetpack_notice() {
4865
4866
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4867
			return;
4868
		}
4869
4870
		switch ( $_GET['jetpack-notice'] ) {
4871
			case 'dismiss':
4872
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4873
4874
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4875
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4876
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4877
				}
4878
				break;
4879
		}
4880
	}
4881
4882
	public static function sort_modules( $a, $b ) {
4883
		if ( $a['sort'] == $b['sort'] ) {
4884
			return 0;
4885
		}
4886
4887
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4888
	}
4889
4890
	function ajax_recheck_ssl() {
4891
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4892
		$result = self::permit_ssl( true );
4893
		wp_send_json(
4894
			array(
4895
				'enabled' => $result,
4896
				'message' => get_transient( 'jetpack_https_test_message' ),
4897
			)
4898
		);
4899
	}
4900
4901
	/* Client API */
4902
4903
	/**
4904
	 * Returns the requested Jetpack API URL
4905
	 *
4906
	 * @deprecated since 7.7
4907
	 * @return string
4908
	 */
4909
	public static function api_url( $relative_url ) {
4910
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
4911
		$connection = self::connection();
4912
		return $connection->api_url( $relative_url );
4913
	}
4914
4915
	/**
4916
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
4917
	 *
4918
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4919
	 */
4920
	public static function fix_url_for_bad_hosts( $url ) {
4921
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
4922
		return Connection_Utils::fix_url_for_bad_hosts( $url );
4923
	}
4924
4925
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
4926
		// Default to a blog token.
4927
		$token_type = 'blog';
4928
4929
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
4930
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
4931
			if ( ! empty( $_GET['onboarding'] ) ) {
4932
				$jpo = $_GET;
4933
			} else {
4934
				$jpo = json_decode( $request_data, true );
4935
			}
4936
4937
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
4938
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
4939
4940
			if (
4941
				isset( $jpo_user )
4942
				&& isset( $jpo_token )
4943
				&& is_email( $jpo_user )
4944
				&& ctype_alnum( $jpo_token )
4945
				&& isset( $_GET['rest_route'] )
4946
				&& self::validate_onboarding_token_action(
4947
					$jpo_token,
4948
					$_GET['rest_route']
4949
				)
4950
			) {
4951
				$jp_user = get_user_by( 'email', $jpo_user );
4952
				if ( is_a( $jp_user, 'WP_User' ) ) {
4953
					wp_set_current_user( $jp_user->ID );
4954
					$user_can = is_multisite()
4955
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
4956
						: current_user_can( 'manage_options' );
4957
					if ( $user_can ) {
4958
						$token_type              = 'user';
4959
						$token->external_user_id = $jp_user->ID;
4960
					}
4961
				}
4962
			}
4963
4964
			$token_data['type']    = $token_type;
4965
			$token_data['user_id'] = $token->external_user_id;
4966
		}
4967
4968
		return $token_data;
4969
	}
4970
4971
	/**
4972
	 * Create a random secret for validating onboarding payload
4973
	 *
4974
	 * @return string Secret token
4975
	 */
4976
	public static function create_onboarding_token() {
4977
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4978
			$token = wp_generate_password( 32, false );
4979
			Jetpack_Options::update_option( 'onboarding', $token );
4980
		}
4981
4982
		return $token;
4983
	}
4984
4985
	/**
4986
	 * Remove the onboarding token
4987
	 *
4988
	 * @return bool True on success, false on failure
4989
	 */
4990
	public static function invalidate_onboarding_token() {
4991
		return Jetpack_Options::delete_option( 'onboarding' );
4992
	}
4993
4994
	/**
4995
	 * Validate an onboarding token for a specific action
4996
	 *
4997
	 * @return boolean True if token/action pair is accepted, false if not
4998
	 */
4999
	public static function validate_onboarding_token_action( $token, $action ) {
5000
		// Compare tokens, bail if tokens do not match
5001
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5002
			return false;
5003
		}
5004
5005
		// List of valid actions we can take
5006
		$valid_actions = array(
5007
			'/jetpack/v4/settings',
5008
		);
5009
5010
		// Whitelist the action
5011
		if ( ! in_array( $action, $valid_actions ) ) {
5012
			return false;
5013
		}
5014
5015
		return true;
5016
	}
5017
5018
	/**
5019
	 * Checks to see if the URL is using SSL to connect with Jetpack
5020
	 *
5021
	 * @since 2.3.3
5022
	 * @return boolean
5023
	 */
5024
	public static function permit_ssl( $force_recheck = false ) {
5025
		// Do some fancy tests to see if ssl is being supported
5026
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5027
			$message = '';
5028
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5029
				$ssl = 0;
5030
			} else {
5031
				switch ( JETPACK_CLIENT__HTTPS ) {
5032
					case 'NEVER':
5033
						$ssl     = 0;
5034
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5035
						break;
5036
					case 'ALWAYS':
5037
					case 'AUTO':
5038
					default:
5039
						$ssl = 1;
5040
						break;
5041
				}
5042
5043
				// If it's not 'NEVER', test to see
5044
				if ( $ssl ) {
5045
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5046
						$ssl     = 0;
5047
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5048
					} else {
5049
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5050
						if ( is_wp_error( $response ) ) {
5051
							$ssl     = 0;
5052
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5053
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5054
							$ssl     = 0;
5055
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5056
						}
5057
					}
5058
				}
5059
			}
5060
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5061
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5062
		}
5063
5064
		return (bool) $ssl;
5065
	}
5066
5067
	/*
5068
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5069
	 */
5070
	public function alert_auto_ssl_fail() {
5071
		if ( ! current_user_can( 'manage_options' ) ) {
5072
			return;
5073
		}
5074
5075
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5076
		?>
5077
5078
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5079
			<div class="jp-banner__content">
5080
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5081
				<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>
5082
				<p>
5083
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5084
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5085
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5086
				</p>
5087
				<p>
5088
					<?php
5089
					printf(
5090
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5091
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5092
						esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' )
5093
					);
5094
					?>
5095
				</p>
5096
			</div>
5097
		</div>
5098
		<style>
5099
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5100
		</style>
5101
		<script type="text/javascript">
5102
			jQuery( document ).ready( function( $ ) {
5103
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5104
					var $this = $( this );
5105
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5106
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5107
					e.preventDefault();
5108
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5109
					$.post( ajaxurl, data )
5110
					  .done( function( response ) {
5111
						  if ( response.enabled ) {
5112
							  $( '#jetpack-ssl-warning' ).hide();
5113
						  } else {
5114
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5115
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5116
						  }
5117
					  }.bind( $this ) );
5118
				} );
5119
			} );
5120
		</script>
5121
5122
		<?php
5123
	}
5124
5125
	/**
5126
	 * Returns the Jetpack XML-RPC API
5127
	 *
5128
	 * @deprecated 8.0 Use Connection_Manager instead.
5129
	 * @return string
5130
	 */
5131
	public static function xmlrpc_api_url() {
5132
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5133
		return self::connection()->xmlrpc_api_url();
5134
	}
5135
5136
	/**
5137
	 * Returns the connection manager object.
5138
	 *
5139
	 * @return Automattic\Jetpack\Connection\Manager
5140
	 */
5141
	public static function connection() {
5142
		return self::init()->connection_manager;
5143
	}
5144
5145
	/**
5146
	 * Creates two secret tokens and the end of life timestamp for them.
5147
	 *
5148
	 * Note these tokens are unique per call, NOT static per site for connecting.
5149
	 *
5150
	 * @since 2.6
5151
	 * @param String  $action  The action name.
5152
	 * @param Integer $user_id The user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be false|integer?

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

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

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

Loading history...
5153
	 * @param Integer $exp     Expiration time in seconds.
5154
	 * @return array
5155
	 */
5156
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5157
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5158
	}
5159
5160
	public static function get_secrets( $action, $user_id ) {
5161
		$secrets = self::connection()->get_secrets( $action, $user_id );
5162
5163
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5164
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_missing'.

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

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

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

Loading history...
5165
		}
5166
5167
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5168
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_expired'.

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

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

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

Loading history...
5169
		}
5170
5171
		return $secrets;
5172
	}
5173
5174
	/**
5175
	 * @deprecated 7.5 Use Connection_Manager instead.
5176
	 *
5177
	 * @param $action
5178
	 * @param $user_id
5179
	 */
5180
	public static function delete_secrets( $action, $user_id ) {
5181
		return self::connection()->delete_secrets( $action, $user_id );
5182
	}
5183
5184
	/**
5185
	 * Builds the timeout limit for queries talking with the wpcom servers.
5186
	 *
5187
	 * Based on local php max_execution_time in php.ini
5188
	 *
5189
	 * @since 2.6
5190
	 * @return int
5191
	 * @deprecated
5192
	 **/
5193
	public function get_remote_query_timeout_limit() {
5194
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5195
		return self::get_max_execution_time();
5196
	}
5197
5198
	/**
5199
	 * Builds the timeout limit for queries talking with the wpcom servers.
5200
	 *
5201
	 * Based on local php max_execution_time in php.ini
5202
	 *
5203
	 * @since 5.4
5204
	 * @return int
5205
	 **/
5206
	public static function get_max_execution_time() {
5207
		$timeout = (int) ini_get( 'max_execution_time' );
5208
5209
		// Ensure exec time set in php.ini
5210
		if ( ! $timeout ) {
5211
			$timeout = 30;
5212
		}
5213
		return $timeout;
5214
	}
5215
5216
	/**
5217
	 * Sets a minimum request timeout, and returns the current timeout
5218
	 *
5219
	 * @since 5.4
5220
	 **/
5221 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5222
		$timeout = self::get_max_execution_time();
5223
		if ( $timeout < $min_timeout ) {
5224
			$timeout = $min_timeout;
5225
			set_time_limit( $timeout );
5226
		}
5227
		return $timeout;
5228
	}
5229
5230
	/**
5231
	 * Takes the response from the Jetpack register new site endpoint and
5232
	 * verifies it worked properly.
5233
	 *
5234
	 * @since 2.6
5235
	 * @deprecated since 7.7.0
5236
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5237
	 **/
5238
	public function validate_remote_register_response() {
5239
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5240
	}
5241
5242
	/**
5243
	 * @return bool|WP_Error
5244
	 */
5245
	public static function register() {
5246
		$tracking = new Tracking();
5247
		$tracking->record_user_event( 'jpc_register_begin' );
5248
5249
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5250
5251
		$connection   = self::connection();
5252
		$registration = $connection->register();
5253
5254
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5255
5256
		if ( ! $registration || is_wp_error( $registration ) ) {
5257
			return $registration;
5258
		}
5259
5260
		return true;
5261
	}
5262
5263
	/**
5264
	 * Filters the registration request body to include tracking properties.
5265
	 *
5266
	 * @param Array $properties
5267
	 * @return Array amended properties.
5268
	 */
5269 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5270
		$tracking        = new Tracking();
5271
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5272
5273
		return array_merge(
5274
			$properties,
5275
			array(
5276
				'_ui' => $tracks_identity['_ui'],
5277
				'_ut' => $tracks_identity['_ut'],
5278
			)
5279
		);
5280
	}
5281
5282
	/**
5283
	 * Filters the token request body to include tracking properties.
5284
	 *
5285
	 * @param Array $properties
5286
	 * @return Array amended properties.
5287
	 */
5288 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5289
		$tracking        = new Tracking();
5290
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5291
5292
		return array_merge(
5293
			$properties,
5294
			array(
5295
				'_ui' => $tracks_identity['_ui'],
5296
				'_ut' => $tracks_identity['_ut'],
5297
			)
5298
		);
5299
	}
5300
5301
	/**
5302
	 * If the db version is showing something other that what we've got now, bump it to current.
5303
	 *
5304
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
Documentation introduced by
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

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

Loading history...
5305
	 */
5306
	public static function maybe_set_version_option() {
5307
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5308
		if ( JETPACK__VERSION != $version ) {
5309
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5310
5311
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5312
				/** This action is documented in class.jetpack.php */
5313
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5314
			}
5315
5316
			return true;
5317
		}
5318
		return false;
5319
	}
5320
5321
	/* Client Server API */
5322
5323
	/**
5324
	 * Loads the Jetpack XML-RPC client.
5325
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5326
	 *
5327
	 * @deprecated since 7.7.0
5328
	 */
5329
	public static function load_xml_rpc_client() {
5330
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5331
	}
5332
5333
	/**
5334
	 * Resets the saved authentication state in between testing requests.
5335
	 */
5336
	public function reset_saved_auth_state() {
5337
		$this->rest_authentication_status = null;
5338
		$this->connection_manager->reset_saved_auth_state();
5339
	}
5340
5341
	/**
5342
	 * Verifies the signature of the current request.
5343
	 *
5344
	 * @deprecated since 7.7.0
5345
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5346
	 *
5347
	 * @return false|array
5348
	 */
5349
	public function verify_xml_rpc_signature() {
5350
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5351
		return self::connection()->verify_xml_rpc_signature();
5352
	}
5353
5354
	/**
5355
	 * Verifies the signature of the current request.
5356
	 *
5357
	 * This function has side effects and should not be used. Instead,
5358
	 * use the memoized version `->verify_xml_rpc_signature()`.
5359
	 *
5360
	 * @deprecated since 7.7.0
5361
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5362
	 * @internal
5363
	 */
5364
	private function internal_verify_xml_rpc_signature() {
5365
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5366
	}
5367
5368
	/**
5369
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5370
	 *
5371
	 * @deprecated since 7.7.0
5372
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5373
	 *
5374
	 * @param \WP_User|mixed $user     User object if authenticated.
5375
	 * @param string         $username Username.
5376
	 * @param string         $password Password string.
5377
	 * @return \WP_User|mixed Authenticated user or error.
5378
	 */
5379
	public function authenticate_jetpack( $user, $username, $password ) {
5380
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5381
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5382
	}
5383
5384
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5385
	// Uses the existing XMLRPC request signing implementation.
5386
	function wp_rest_authenticate( $user ) {
5387
		if ( ! empty( $user ) ) {
5388
			// Another authentication method is in effect.
5389
			return $user;
5390
		}
5391
5392
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5393
			// Nothing to do for this authentication method.
5394
			return null;
5395
		}
5396
5397
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5398
			// Nothing to do for this authentication method.
5399
			return null;
5400
		}
5401
5402
		// Ensure that we always have the request body available.  At this
5403
		// point, the WP REST API code to determine the request body has not
5404
		// run yet.  That code may try to read from 'php://input' later, but
5405
		// this can only be done once per request in PHP versions prior to 5.6.
5406
		// So we will go ahead and perform this read now if needed, and save
5407
		// the request body where both the Jetpack signature verification code
5408
		// and the WP REST API code can see it.
5409
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5410
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5411
		}
5412
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5413
5414
		// Only support specific request parameters that have been tested and
5415
		// are known to work with signature verification.  A different method
5416
		// can be passed to the WP REST API via the '?_method=' parameter if
5417
		// needed.
5418
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5419
			$this->rest_authentication_status = new WP_Error(
5420
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

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

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

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

Loading history...
5421
				__( 'This request method is not supported.', 'jetpack' ),
5422
				array( 'status' => 400 )
5423
			);
5424
			return null;
5425
		}
5426
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5427
			$this->rest_authentication_status = new WP_Error(
5428
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

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

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

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

Loading history...
5429
				__( 'This request method does not support body parameters.', 'jetpack' ),
5430
				array( 'status' => 400 )
5431
			);
5432
			return null;
5433
		}
5434
5435
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5436
5437
		if (
5438
			$verified &&
5439
			isset( $verified['type'] ) &&
5440
			'user' === $verified['type'] &&
5441
			! empty( $verified['user_id'] )
5442
		) {
5443
			// Authentication successful.
5444
			$this->rest_authentication_status = true;
5445
			return $verified['user_id'];
5446
		}
5447
5448
		// Something else went wrong.  Probably a signature error.
5449
		$this->rest_authentication_status = new WP_Error(
5450
			'rest_invalid_signature',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_signature'.

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

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

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

Loading history...
5451
			__( 'The request is not signed correctly.', 'jetpack' ),
5452
			array( 'status' => 400 )
5453
		);
5454
		return null;
5455
	}
5456
5457
	/**
5458
	 * Report authentication status to the WP REST API.
5459
	 *
5460
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
5461
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5462
	 */
5463
	public function wp_rest_authentication_errors( $value ) {
5464
		if ( $value !== null ) {
5465
			return $value;
5466
		}
5467
		return $this->rest_authentication_status;
5468
	}
5469
5470
	/**
5471
	 * Add our nonce to this request.
5472
	 *
5473
	 * @deprecated since 7.7.0
5474
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5475
	 *
5476
	 * @param int    $timestamp Timestamp of the request.
5477
	 * @param string $nonce     Nonce string.
5478
	 */
5479
	public function add_nonce( $timestamp, $nonce ) {
5480
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5481
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5482
	}
5483
5484
	/**
5485
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5486
	 * Capture it here so we can verify the signature later.
5487
	 *
5488
	 * @deprecated since 7.7.0
5489
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5490
	 *
5491
	 * @param array $methods XMLRPC methods.
5492
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5493
	 */
5494
	public function xmlrpc_methods( $methods ) {
5495
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5496
		return $this->connection_manager->xmlrpc_methods( $methods );
5497
	}
5498
5499
	/**
5500
	 * Register additional public XMLRPC methods.
5501
	 *
5502
	 * @deprecated since 7.7.0
5503
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5504
	 *
5505
	 * @param array $methods Public XMLRPC methods.
5506
	 * @return array Public XMLRPC methods, with the getOptions one.
5507
	 */
5508
	public function public_xmlrpc_methods( $methods ) {
5509
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5510
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5511
	}
5512
5513
	/**
5514
	 * Handles a getOptions XMLRPC method call.
5515
	 *
5516
	 * @deprecated since 7.7.0
5517
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5518
	 *
5519
	 * @param array $args method call arguments.
5520
	 * @return array an amended XMLRPC server options array.
5521
	 */
5522
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5523
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5524
		return $this->connection_manager->jetpack_getOptions( $args );
0 ignored issues
show
Bug introduced by
The method jetpack_getOptions() does not exist on Automattic\Jetpack\Connection\Manager. Did you maybe mean jetpack_get_options()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
5525
	}
5526
5527
	/**
5528
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5529
	 *
5530
	 * @deprecated since 7.7.0
5531
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5532
	 *
5533
	 * @param array $options Standard Core options.
5534
	 * @return array Amended options.
5535
	 */
5536
	public function xmlrpc_options( $options ) {
5537
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5538
		return $this->connection_manager->xmlrpc_options( $options );
5539
	}
5540
5541
	/**
5542
	 * Cleans nonces that were saved when calling ::add_nonce.
5543
	 *
5544
	 * @deprecated since 7.7.0
5545
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5546
	 *
5547
	 * @param bool $all whether to clean even non-expired nonces.
5548
	 */
5549
	public static function clean_nonces( $all = false ) {
5550
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5551
		return self::connection()->clean_nonces( $all );
5552
	}
5553
5554
	/**
5555
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5556
	 * SET: state( $key, $value );
5557
	 * GET: $value = state( $key );
5558
	 *
5559
	 * @param string $key
0 ignored issues
show
Documentation introduced by
Should the type for parameter $key not be string|null?

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

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

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

Loading history...
5560
	 * @param string $value
0 ignored issues
show
Documentation introduced by
Should the type for parameter $value not be string|null?

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

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

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

Loading history...
5561
	 * @param bool   $restate private
5562
	 */
5563
	public static function state( $key = null, $value = null, $restate = false ) {
5564
		static $state = array();
5565
		static $path, $domain;
5566
		if ( ! isset( $path ) ) {
5567
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5568
			$admin_url = self::admin_url();
5569
			$bits      = wp_parse_url( $admin_url );
5570
5571
			if ( is_array( $bits ) ) {
5572
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5573
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5574
			} else {
5575
				$path = $domain = null;
5576
			}
5577
		}
5578
5579
		// Extract state from cookies and delete cookies
5580
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5581
			$yum = $_COOKIE['jetpackState'];
5582
			unset( $_COOKIE['jetpackState'] );
5583
			foreach ( $yum as $k => $v ) {
5584
				if ( strlen( $v ) ) {
5585
					$state[ $k ] = $v;
5586
				}
5587
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5588
			}
5589
		}
5590
5591
		if ( $restate ) {
5592
			foreach ( $state as $k => $v ) {
5593
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5594
			}
5595
			return;
5596
		}
5597
5598
		// Get a state variable
5599
		if ( isset( $key ) && ! isset( $value ) ) {
5600
			if ( array_key_exists( $key, $state ) ) {
5601
				return $state[ $key ];
5602
			}
5603
			return null;
5604
		}
5605
5606
		// Set a state variable
5607
		if ( isset( $key ) && isset( $value ) ) {
5608
			if ( is_array( $value ) && isset( $value[0] ) ) {
5609
				$value = $value[0];
5610
			}
5611
			$state[ $key ] = $value;
5612
			if ( ! headers_sent() ) {
5613
				setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5614
			}
5615
		}
5616
	}
5617
5618
	public static function restate() {
5619
		self::state( null, null, true );
5620
	}
5621
5622
	public static function check_privacy( $file ) {
5623
		static $is_site_publicly_accessible = null;
5624
5625
		if ( is_null( $is_site_publicly_accessible ) ) {
5626
			$is_site_publicly_accessible = false;
5627
5628
			$rpc = new Jetpack_IXR_Client();
5629
5630
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5631
			if ( $success ) {
5632
				$response = $rpc->getResponse();
5633
				if ( $response ) {
5634
					$is_site_publicly_accessible = true;
5635
				}
5636
			}
5637
5638
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5639
		}
5640
5641
		if ( $is_site_publicly_accessible ) {
5642
			return;
5643
		}
5644
5645
		$module_slug = self::get_module_slug( $file );
5646
5647
		$privacy_checks = self::state( 'privacy_checks' );
5648
		if ( ! $privacy_checks ) {
5649
			$privacy_checks = $module_slug;
5650
		} else {
5651
			$privacy_checks .= ",$module_slug";
5652
		}
5653
5654
		self::state( 'privacy_checks', $privacy_checks );
5655
	}
5656
5657
	/**
5658
	 * Helper method for multicall XMLRPC.
5659
	 *
5660
	 * @param ...$args Args for the async_call.
5661
	 */
5662
	public static function xmlrpc_async_call( ...$args ) {
5663
		global $blog_id;
5664
		static $clients = array();
5665
5666
		$client_blog_id = is_multisite() ? $blog_id : 0;
5667
5668
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5669
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5670
			if ( function_exists( 'ignore_user_abort' ) ) {
5671
				ignore_user_abort( true );
5672
			}
5673
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5674
		}
5675
5676
		if ( ! empty( $args[0] ) ) {
5677
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5678
		} elseif ( is_multisite() ) {
5679
			foreach ( $clients as $client_blog_id => $client ) {
5680
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5681
					continue;
5682
				}
5683
5684
				$switch_success = switch_to_blog( $client_blog_id, true );
5685
				if ( ! $switch_success ) {
5686
					continue;
5687
				}
5688
5689
				flush();
5690
				$client->query();
5691
5692
				restore_current_blog();
5693
			}
5694
		} else {
5695
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5696
				flush();
5697
				$clients[0]->query();
5698
			}
5699
		}
5700
	}
5701
5702
	public static function staticize_subdomain( $url ) {
5703
5704
		// Extract hostname from URL
5705
		$host = wp_parse_url( $url, PHP_URL_HOST );
5706
5707
		// Explode hostname on '.'
5708
		$exploded_host = explode( '.', $host );
5709
5710
		// Retrieve the name and TLD
5711
		if ( count( $exploded_host ) > 1 ) {
5712
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5713
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5714
			// Rebuild domain excluding subdomains
5715
			$domain = $name . '.' . $tld;
5716
		} else {
5717
			$domain = $host;
5718
		}
5719
		// Array of Automattic domains
5720
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5721
5722
		// Return $url if not an Automattic domain
5723
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5724
			return $url;
5725
		}
5726
5727
		if ( is_ssl() ) {
5728
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5729
		}
5730
5731
		srand( crc32( basename( $url ) ) );
5732
		$static_counter = rand( 0, 2 );
5733
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5734
5735
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5736
	}
5737
5738
	/* JSON API Authorization */
5739
5740
	/**
5741
	 * Handles the login action for Authorizing the JSON API
5742
	 */
5743
	function login_form_json_api_authorization() {
5744
		$this->verify_json_api_authorization_request();
5745
5746
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5747
5748
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5749
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5750
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5751
	}
5752
5753
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5754
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5755
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5756
			return $url;
5757
		}
5758
5759
		$parsed_url = wp_parse_url( $url );
5760
		$url        = strtok( $url, '?' );
5761
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5762
		if ( ! empty( $parsed_url['query'] ) ) {
5763
			$url .= "&{$parsed_url['query']}";
5764
		}
5765
5766
		return $url;
5767
	}
5768
5769
	// Make sure the POSTed request is handled by the same action
5770
	function preserve_action_in_login_form_for_json_api_authorization() {
5771
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5772
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5773
	}
5774
5775
	// If someone logs in to approve API access, store the Access Code in usermeta
5776
	function store_json_api_authorization_token( $user_login, $user ) {
5777
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5778
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5779
		$token = wp_generate_password( 32, false );
5780
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5781
	}
5782
5783
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5784
	function allow_wpcom_public_api_domain( $domains ) {
5785
		$domains[] = 'public-api.wordpress.com';
5786
		return $domains;
5787
	}
5788
5789
	static function is_redirect_encoded( $redirect_url ) {
5790
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5791
	}
5792
5793
	// Add all wordpress.com environments to the safe redirect whitelist
5794
	function allow_wpcom_environments( $domains ) {
5795
		$domains[] = 'wordpress.com';
5796
		$domains[] = 'wpcalypso.wordpress.com';
5797
		$domains[] = 'horizon.wordpress.com';
5798
		$domains[] = 'calypso.localhost';
5799
		return $domains;
5800
	}
5801
5802
	// Add the Access Code details to the public-api.wordpress.com redirect
5803
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5804
		return add_query_arg(
5805
			urlencode_deep(
5806
				array(
5807
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5808
					'jetpack-user-id' => (int) $user->ID,
5809
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5810
				)
5811
			),
5812
			$redirect_to
5813
		);
5814
	}
5815
5816
5817
	/**
5818
	 * Verifies the request by checking the signature
5819
	 *
5820
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5821
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5822
	 *
5823
	 * @param null|array $environment
5824
	 */
5825
	function verify_json_api_authorization_request( $environment = null ) {
5826
		$environment = is_null( $environment )
5827
			? $_REQUEST
5828
			: $environment;
5829
5830
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envVersion is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
5831
		$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...
5832
		if ( ! $token || empty( $token->secret ) ) {
5833
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5834
		}
5835
5836
		$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' );
5837
5838
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5839
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5840
			/**
5841
			 * Jetpack authorisation request Error.
5842
			 *
5843
			 * @since 7.5.0
5844
			 */
5845
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5846
			$die_error = sprintf(
5847
				/* translators: %s is a URL */
5848
				__( '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' ),
5849
				'https://jetpack.com/support/double-encoding/'
5850
			);
5851
		}
5852
5853
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5854
5855
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5856
			$signature = $jetpack_signature->sign_request(
5857
				$environment['token'],
5858
				$environment['timestamp'],
5859
				$environment['nonce'],
5860
				'',
5861
				'GET',
5862
				$environment['jetpack_json_api_original_query'],
5863
				null,
5864
				true
5865
			);
5866
		} else {
5867
			$signature = $jetpack_signature->sign_current_request(
5868
				array(
5869
					'body'   => null,
5870
					'method' => 'GET',
5871
				)
5872
			);
5873
		}
5874
5875
		if ( ! $signature ) {
5876
			wp_die( $die_error );
5877
		} elseif ( is_wp_error( $signature ) ) {
5878
			wp_die( $die_error );
5879
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
5880
			if ( is_ssl() ) {
5881
				// 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
5882
				$signature = $jetpack_signature->sign_current_request(
5883
					array(
5884
						'scheme' => 'http',
5885
						'body'   => null,
5886
						'method' => 'GET',
5887
					)
5888
				);
5889
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5890
					wp_die( $die_error );
5891
				}
5892
			} else {
5893
				wp_die( $die_error );
5894
			}
5895
		}
5896
5897
		$timestamp = (int) $environment['timestamp'];
5898
		$nonce     = stripslashes( (string) $environment['nonce'] );
5899
5900
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
5901
			// De-nonce the nonce, at least for 5 minutes.
5902
			// 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)
5903
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5904
			if ( $old_nonce_time < time() - 300 ) {
5905
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
5906
			}
5907
		}
5908
5909
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5910
		$data_filters = array(
5911
			'state'        => 'opaque',
5912
			'client_id'    => 'int',
5913
			'client_title' => 'string',
5914
			'client_image' => 'url',
5915
		);
5916
5917
		foreach ( $data_filters as $key => $sanitation ) {
5918
			if ( ! isset( $data->$key ) ) {
5919
				wp_die( $die_error );
5920
			}
5921
5922
			switch ( $sanitation ) {
5923
				case 'int':
5924
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
5925
					break;
5926
				case 'opaque':
5927
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
5928
					break;
5929
				case 'string':
5930
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
5931
					break;
5932
				case 'url':
5933
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
5934
					break;
5935
			}
5936
		}
5937
5938
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5939
			wp_die( $die_error );
5940
		}
5941
	}
5942
5943
	function login_message_json_api_authorization( $message ) {
5944
		return '<p class="message">' . sprintf(
5945
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
5946
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5947
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5948
	}
5949
5950
	/**
5951
	 * Get $content_width, but with a <s>twist</s> filter.
5952
	 */
5953
	public static function get_content_width() {
5954
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5955
			? $GLOBALS['content_width']
5956
			: false;
5957
		/**
5958
		 * Filter the Content Width value.
5959
		 *
5960
		 * @since 2.2.3
5961
		 *
5962
		 * @param string $content_width Content Width value.
5963
		 */
5964
		return apply_filters( 'jetpack_content_width', $content_width );
5965
	}
5966
5967
	/**
5968
	 * Pings the WordPress.com Mirror Site for the specified options.
5969
	 *
5970
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5971
	 *
5972
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5973
	 */
5974
	public function get_cloud_site_options( $option_names ) {
5975
		$option_names = array_filter( (array) $option_names, 'is_string' );
5976
5977
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
5978
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5979
		if ( $xml->isError() ) {
5980
			return array(
5981
				'error_code' => $xml->getErrorCode(),
5982
				'error_msg'  => $xml->getErrorMessage(),
5983
			);
5984
		}
5985
		$cloud_site_options = $xml->getResponse();
5986
5987
		return $cloud_site_options;
5988
	}
5989
5990
	/**
5991
	 * Checks if the site is currently in an identity crisis.
5992
	 *
5993
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5994
	 */
5995
	public static function check_identity_crisis() {
5996
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5997
			return false;
5998
		}
5999
6000
		return Jetpack_Options::get_option( 'sync_error_idc' );
6001
	}
6002
6003
	/**
6004
	 * Checks whether the home and siteurl specifically are whitelisted
6005
	 * Written so that we don't have re-check $key and $value params every time
6006
	 * we want to check if this site is whitelisted, for example in footer.php
6007
	 *
6008
	 * @since  3.8.0
6009
	 * @return bool True = already whitelisted False = not whitelisted
6010
	 */
6011
	public static function is_staging_site() {
6012
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6013
		return ( new Status() )->is_staging_site();
6014
	}
6015
6016
	/**
6017
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6018
	 *
6019
	 * @since 4.4.0
6020
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6021
	 *
6022
	 * @return bool
6023
	 */
6024
	public static function validate_sync_error_idc_option() {
6025
		$is_valid = false;
6026
6027
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6028
		if ( false === $idc_allowed ) {
6029
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6030
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6031
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6032
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6033
				$transient_duration = HOUR_IN_SECONDS;
6034
			} else {
6035
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6036
				$idc_allowed        = '1';
6037
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6038
			}
6039
6040
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6041
		}
6042
6043
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6044
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6045
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6046
			$local_options = self::get_sync_error_idc_option();
6047
			// Ensure all values are set.
6048
			if ( isset( $sync_error['home'] ) && isset ( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6049
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6050
					$is_valid = true;
6051
				}
6052
			}
6053
6054
		}
6055
6056
		/**
6057
		 * Filters whether the sync_error_idc option is valid.
6058
		 *
6059
		 * @since 4.4.0
6060
		 *
6061
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6062
		 */
6063
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6064
6065
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6066
			// Since the option exists, and did not validate, delete it
6067
			Jetpack_Options::delete_option( 'sync_error_idc' );
6068
		}
6069
6070
		return $is_valid;
6071
	}
6072
6073
	/**
6074
	 * Normalizes a url by doing three things:
6075
	 *  - Strips protocol
6076
	 *  - Strips www
6077
	 *  - Adds a trailing slash
6078
	 *
6079
	 * @since 4.4.0
6080
	 * @param string $url
6081
	 * @return WP_Error|string
6082
	 */
6083
	public static function normalize_url_protocol_agnostic( $url ) {
6084
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6085
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6086
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'cannot_parse_url'.

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

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

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

Loading history...
6087
		}
6088
6089
		// Strip www and protocols
6090
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6091
		return $url;
6092
	}
6093
6094
	/**
6095
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6096
	 *
6097
	 * @since 4.4.0
6098
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6099
	 *
6100
	 * @param array $response
6101
	 * @return array Array of the local urls, wpcom urls, and error code
6102
	 */
6103
	public static function get_sync_error_idc_option( $response = array() ) {
6104
		// Since the local options will hit the database directly, store the values
6105
		// in a transient to allow for autoloading and caching on subsequent views.
6106
		$local_options = get_transient( 'jetpack_idc_local' );
6107
		if ( false === $local_options ) {
6108
			$local_options = array(
6109
				'home'    => Functions::home_url(),
6110
				'siteurl' => Functions::site_url(),
6111
			);
6112
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6113
		}
6114
6115
		$options = array_merge( $local_options, $response );
6116
6117
		$returned_values = array();
6118
		foreach ( $options as $key => $option ) {
6119
			if ( 'error_code' === $key ) {
6120
				$returned_values[ $key ] = $option;
6121
				continue;
6122
			}
6123
6124
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6125
				continue;
6126
			}
6127
6128
			$returned_values[ $key ] = $normalized_url;
6129
		}
6130
6131
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6132
6133
		return $returned_values;
6134
	}
6135
6136
	/**
6137
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6138
	 * If set to true, the site will be put into staging mode.
6139
	 *
6140
	 * @since 4.3.2
6141
	 * @return bool
6142
	 */
6143
	public static function sync_idc_optin() {
6144
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6145
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6146
		} else {
6147
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6148
		}
6149
6150
		/**
6151
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6152
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6153
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6154
		 *
6155
		 * @since 4.3.2
6156
		 *
6157
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6158
		 */
6159
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6160
	}
6161
6162
	/**
6163
	 * Maybe Use a .min.css stylesheet, maybe not.
6164
	 *
6165
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6166
	 */
6167
	public static function maybe_min_asset( $url, $path, $plugin ) {
6168
		// Short out on things trying to find actual paths.
6169
		if ( ! $path || empty( $plugin ) ) {
6170
			return $url;
6171
		}
6172
6173
		$path = ltrim( $path, '/' );
6174
6175
		// Strip out the abspath.
6176
		$base = dirname( plugin_basename( $plugin ) );
6177
6178
		// Short out on non-Jetpack assets.
6179
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6180
			return $url;
6181
		}
6182
6183
		// File name parsing.
6184
		$file              = "{$base}/{$path}";
6185
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6186
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6187
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6188
		$extension         = array_shift( $file_name_parts_r );
6189
6190
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6191
			// Already pointing at the minified version.
6192
			if ( 'min' === $file_name_parts_r[0] ) {
6193
				return $url;
6194
			}
6195
6196
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6197
			if ( file_exists( $min_full_path ) ) {
6198
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6199
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6200
				if ( 'css' === $extension ) {
6201
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6202
					self::$min_assets[ $key ] = $path;
6203
				}
6204
			}
6205
		}
6206
6207
		return $url;
6208
	}
6209
6210
	/**
6211
	 * If the asset is minified, let's flag .min as the suffix.
6212
	 *
6213
	 * Attached to `style_loader_src` filter.
6214
	 *
6215
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
Bug introduced by
There is no parameter named $tag. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6216
	 * @param string $handle The registered handle of the script in question.
6217
	 * @param string $href The url of the asset in question.
0 ignored issues
show
Bug introduced by
There is no parameter named $href. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6218
	 */
6219
	public static function set_suffix_on_min( $src, $handle ) {
6220
		if ( false === strpos( $src, '.min.css' ) ) {
6221
			return $src;
6222
		}
6223
6224
		if ( ! empty( self::$min_assets ) ) {
6225
			foreach ( self::$min_assets as $file => $path ) {
6226
				if ( false !== strpos( $src, $file ) ) {
6227
					wp_style_add_data( $handle, 'suffix', '.min' );
6228
					return $src;
6229
				}
6230
			}
6231
		}
6232
6233
		return $src;
6234
	}
6235
6236
	/**
6237
	 * Maybe inlines a stylesheet.
6238
	 *
6239
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6240
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6241
	 *
6242
	 * Attached to `style_loader_tag` filter.
6243
	 *
6244
	 * @param string $tag The tag that would link to the external asset.
6245
	 * @param string $handle The registered handle of the script in question.
6246
	 *
6247
	 * @return string
6248
	 */
6249
	public static function maybe_inline_style( $tag, $handle ) {
6250
		global $wp_styles;
6251
		$item = $wp_styles->registered[ $handle ];
6252
6253
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6254
			return $tag;
6255
		}
6256
6257
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6258
			$href = $matches[1];
6259
			// Strip off query string
6260
			if ( $pos = strpos( $href, '?' ) ) {
6261
				$href = substr( $href, 0, $pos );
6262
			}
6263
			// Strip off fragment
6264
			if ( $pos = strpos( $href, '#' ) ) {
6265
				$href = substr( $href, 0, $pos );
6266
			}
6267
		} else {
6268
			return $tag;
6269
		}
6270
6271
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6272
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6273
			return $tag;
6274
		}
6275
6276
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6277
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6278
			// And this isn't the pass that actually deals with the RTL version...
6279
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6280
				// Short out, as the RTL version will deal with it in a moment.
6281
				return $tag;
6282
			}
6283
		}
6284
6285
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6286
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6287
		if ( $css ) {
6288
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6289
			if ( empty( $item->extra['after'] ) ) {
6290
				wp_add_inline_style( $handle, $css );
6291
			} else {
6292
				array_unshift( $item->extra['after'], $css );
6293
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6294
			}
6295
		}
6296
6297
		return $tag;
6298
	}
6299
6300
	/**
6301
	 * Loads a view file from the views
6302
	 *
6303
	 * Data passed in with the $data parameter will be available in the
6304
	 * template file as $data['value']
6305
	 *
6306
	 * @param string $template - Template file to load
6307
	 * @param array  $data - Any data to pass along to the template
6308
	 * @return boolean - If template file was found
6309
	 **/
6310
	public function load_view( $template, $data = array() ) {
6311
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6312
6313
		if ( file_exists( $views_dir . $template ) ) {
6314
			require_once $views_dir . $template;
6315
			return true;
6316
		}
6317
6318
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6319
		return false;
6320
	}
6321
6322
	/**
6323
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6324
	 */
6325
	public function deprecated_hooks() {
6326
		global $wp_filter;
6327
6328
		/*
6329
		 * Format:
6330
		 * deprecated_filter_name => replacement_name
6331
		 *
6332
		 * If there is no replacement, use null for replacement_name
6333
		 */
6334
		$deprecated_list = array(
6335
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6336
			'wpl_sharing_2014_1'                           => null,
6337
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6338
			'jetpack_identity_crisis_options_to_check'     => null,
6339
			'update_option_jetpack_single_user_site'       => null,
6340
			'audio_player_default_colors'                  => null,
6341
			'add_option_jetpack_featured_images_enabled'   => null,
6342
			'add_option_jetpack_update_details'            => null,
6343
			'add_option_jetpack_updates'                   => null,
6344
			'add_option_jetpack_network_name'              => null,
6345
			'add_option_jetpack_network_allow_new_registrations' => null,
6346
			'add_option_jetpack_network_add_new_users'     => null,
6347
			'add_option_jetpack_network_site_upload_space' => null,
6348
			'add_option_jetpack_network_upload_file_types' => null,
6349
			'add_option_jetpack_network_enable_administration_menus' => null,
6350
			'add_option_jetpack_is_multi_site'             => null,
6351
			'add_option_jetpack_is_main_network'           => null,
6352
			'add_option_jetpack_main_network_site'         => null,
6353
			'jetpack_sync_all_registered_options'          => null,
6354
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6355
			'jetpack_is_post_mailable'                     => null,
6356
			'jetpack_seo_site_host'                        => null,
6357
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6358
			'jetpack_holiday_snow_option_name'             => null,
6359
			'jetpack_holiday_chance_of_snow'               => null,
6360
			'jetpack_holiday_snow_js_url'                  => null,
6361
			'jetpack_is_holiday_snow_season'               => null,
6362
			'jetpack_holiday_snow_option_updated'          => null,
6363
			'jetpack_holiday_snowing'                      => null,
6364
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6365
			'jetpack_cache_plans'                          => null,
6366
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6367
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6368
			'jetpack_enable_site_verification'             => null,
6369
			'can_display_jetpack_manage_notice'            => null,
6370
			// Removed in Jetpack 7.3.0
6371
			'atd_load_scripts'                             => null,
6372
			'atd_http_post_timeout'                        => null,
6373
			'atd_http_post_error'                          => null,
6374
			'atd_service_domain'                           => null,
6375
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6376
			// Removed in Jetpack 7.9.0
6377
			'jetpack_pwa_manifest'                         => null,
6378
			'jetpack_pwa_background_color'                 => null,
6379
		);
6380
6381
		// This is a silly loop depth. Better way?
6382
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6383
			if ( has_action( $hook ) ) {
6384
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6385
					foreach ( $values as $hooked ) {
6386
						if ( is_callable( $hooked['function'] ) ) {
6387
							$function_name = 'an anonymous function';
6388
						} else {
6389
							$function_name = $hooked['function'];
6390
						}
6391
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6392
					}
6393
				}
6394
			}
6395
		}
6396
	}
6397
6398
	/**
6399
	 * Converts any url in a stylesheet, to the correct absolute url.
6400
	 *
6401
	 * Considerations:
6402
	 *  - Normal, relative URLs     `feh.png`
6403
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6404
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6405
	 *  - Absolute URLs             `http://domain.com/feh.png`
6406
	 *  - Domain root relative URLs `/feh.png`
6407
	 *
6408
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6409
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6410
	 *
6411
	 * @return mixed|string
6412
	 */
6413
	public static function absolutize_css_urls( $css, $css_file_url ) {
6414
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6415
		$css_dir = dirname( $css_file_url );
6416
		$p       = wp_parse_url( $css_dir );
6417
		$domain  = sprintf(
6418
			'%1$s//%2$s%3$s%4$s',
6419
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6420
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6421
			$p['host'],
6422
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6423
		);
6424
6425
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6426
			$find = $replace = array();
6427
			foreach ( $matches as $match ) {
6428
				$url = trim( $match['path'], "'\" \t" );
6429
6430
				// If this is a data url, we don't want to mess with it.
6431
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6432
					continue;
6433
				}
6434
6435
				// If this is an absolute or protocol-agnostic url,
6436
				// we don't want to mess with it.
6437
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6438
					continue;
6439
				}
6440
6441
				switch ( substr( $url, 0, 1 ) ) {
6442
					case '/':
6443
						$absolute = $domain . $url;
6444
						break;
6445
					default:
6446
						$absolute = $css_dir . '/' . $url;
6447
				}
6448
6449
				$find[]    = $match[0];
6450
				$replace[] = sprintf( 'url("%s")', $absolute );
6451
			}
6452
			$css = str_replace( $find, $replace, $css );
6453
		}
6454
6455
		return $css;
6456
	}
6457
6458
	/**
6459
	 * This methods removes all of the registered css files on the front end
6460
	 * from Jetpack in favor of using a single file. In effect "imploding"
6461
	 * all the files into one file.
6462
	 *
6463
	 * Pros:
6464
	 * - Uses only ONE css asset connection instead of 15
6465
	 * - Saves a minimum of 56k
6466
	 * - Reduces server load
6467
	 * - Reduces time to first painted byte
6468
	 *
6469
	 * Cons:
6470
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6471
	 *      should not cause any issues with themes.
6472
	 * - Plugins/themes dequeuing styles no longer do anything. See
6473
	 *      jetpack_implode_frontend_css filter for a workaround
6474
	 *
6475
	 * For some situations developers may wish to disable css imploding and
6476
	 * instead operate in legacy mode where each file loads seperately and
6477
	 * can be edited individually or dequeued. This can be accomplished with
6478
	 * the following line:
6479
	 *
6480
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6481
	 *
6482
	 * @since 3.2
6483
	 **/
6484
	public function implode_frontend_css( $travis_test = false ) {
6485
		$do_implode = true;
6486
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6487
			$do_implode = false;
6488
		}
6489
6490
		// Do not implode CSS when the page loads via the AMP plugin.
6491
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6492
			$do_implode = false;
6493
		}
6494
6495
		/**
6496
		 * Allow CSS to be concatenated into a single jetpack.css file.
6497
		 *
6498
		 * @since 3.2.0
6499
		 *
6500
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6501
		 */
6502
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6503
6504
		// Do not use the imploded file when default behavior was altered through the filter
6505
		if ( ! $do_implode ) {
6506
			return;
6507
		}
6508
6509
		// We do not want to use the imploded file in dev mode, or if not connected
6510
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6511
			if ( ! $travis_test ) {
6512
				return;
6513
			}
6514
		}
6515
6516
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6517
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6518
			return;
6519
		}
6520
6521
		/*
6522
		 * Now we assume Jetpack is connected and able to serve the single
6523
		 * file.
6524
		 *
6525
		 * In the future there will be a check here to serve the file locally
6526
		 * or potentially from the Jetpack CDN
6527
		 *
6528
		 * For now:
6529
		 * - Enqueue a single imploded css file
6530
		 * - Zero out the style_loader_tag for the bundled ones
6531
		 * - Be happy, drink scotch
6532
		 */
6533
6534
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6535
6536
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6537
6538
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6539
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6540
	}
6541
6542
	function concat_remove_style_loader_tag( $tag, $handle ) {
6543
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6544
			$tag = '';
6545
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6546
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6547
			}
6548
		}
6549
6550
		return $tag;
6551
	}
6552
6553
	/**
6554
	 * Add an async attribute to scripts that can be loaded asynchronously.
6555
	 * https://www.w3schools.com/tags/att_script_async.asp
6556
	 *
6557
	 * @since 7.7.0
6558
	 *
6559
	 * @param string $tag    The <script> tag for the enqueued script.
6560
	 * @param string $handle The script's registered handle.
6561
	 * @param string $src    The script's source URL.
6562
	 */
6563
	public function script_add_async( $tag, $handle, $src ) {
6564
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6565
			return preg_replace( '/^<script /i', '<script async ', $tag );
6566
		}
6567
6568
		return $tag;
6569
	}
6570
6571
	/*
6572
	 * Check the heartbeat data
6573
	 *
6574
	 * Organizes the heartbeat data by severity.  For example, if the site
6575
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6576
	 *
6577
	 * Data will be added to "caution" array, if it either:
6578
	 *  - Out of date Jetpack version
6579
	 *  - Out of date WP version
6580
	 *  - Out of date PHP version
6581
	 *
6582
	 * $return array $filtered_data
6583
	 */
6584
	public static function jetpack_check_heartbeat_data() {
6585
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6586
6587
		$good    = array();
6588
		$caution = array();
6589
		$bad     = array();
6590
6591
		foreach ( $raw_data as $stat => $value ) {
6592
6593
			// Check jetpack version
6594
			if ( 'version' == $stat ) {
6595
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6596
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6597
					continue;
6598
				}
6599
			}
6600
6601
			// Check WP version
6602
			if ( 'wp-version' == $stat ) {
6603
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6604
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6605
					continue;
6606
				}
6607
			}
6608
6609
			// Check PHP version
6610
			if ( 'php-version' == $stat ) {
6611
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6612
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_PHP_VERSION;
6613
					continue;
6614
				}
6615
			}
6616
6617
			// Check ID crisis
6618
			if ( 'identitycrisis' == $stat ) {
6619
				if ( 'yes' == $value ) {
6620
					$bad[ $stat ] = $value;
6621
					continue;
6622
				}
6623
			}
6624
6625
			// The rest are good :)
6626
			$good[ $stat ] = $value;
6627
		}
6628
6629
		$filtered_data = array(
6630
			'good'    => $good,
6631
			'caution' => $caution,
6632
			'bad'     => $bad,
6633
		);
6634
6635
		return $filtered_data;
6636
	}
6637
6638
6639
	/*
6640
	 * This method is used to organize all options that can be reset
6641
	 * without disconnecting Jetpack.
6642
	 *
6643
	 * It is used in class.jetpack-cli.php to reset options
6644
	 *
6645
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6646
	 *
6647
	 * @return array of options to delete.
6648
	 */
6649
	public static function get_jetpack_options_for_reset() {
6650
		return Jetpack_Options::get_options_for_reset();
6651
	}
6652
6653
	/*
6654
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6655
	 * so we can bring them directly to their site in calypso.
6656
	 *
6657
	 * @param string | url
6658
	 * @return string | url without the guff
6659
	 */
6660
	public static function build_raw_urls( $url ) {
6661
		$strip_http = '/.*?:\/\//i';
6662
		$url        = preg_replace( $strip_http, '', $url );
6663
		$url        = str_replace( '/', '::', $url );
6664
		return $url;
6665
	}
6666
6667
	/**
6668
	 * Stores and prints out domains to prefetch for page speed optimization.
6669
	 *
6670
	 * @param mixed $new_urls
6671
	 */
6672
	public static function dns_prefetch( $new_urls = null ) {
6673
		static $prefetch_urls = array();
6674
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6675
			echo "\r\n";
6676
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6677
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6678
			}
6679
		} elseif ( ! empty( $new_urls ) ) {
6680
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6681
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6682
			}
6683
			foreach ( (array) $new_urls as $this_new_url ) {
6684
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6685
			}
6686
			$prefetch_urls = array_unique( $prefetch_urls );
6687
		}
6688
	}
6689
6690
	public function wp_dashboard_setup() {
6691
		if ( self::is_active() ) {
6692
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6693
		}
6694
6695
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6696
			$jetpack_logo = new Jetpack_Logo();
6697
			$widget_title = sprintf(
6698
				wp_kses(
6699
					/* translators: Placeholder is a Jetpack logo. */
6700
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6701
					array( 'span' => array() )
6702
				),
6703
				$jetpack_logo->get_jp_emblem( true )
6704
			);
6705
6706
			wp_add_dashboard_widget(
6707
				'jetpack_summary_widget',
6708
				$widget_title,
6709
				array( __CLASS__, 'dashboard_widget' )
6710
			);
6711
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6712
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6713
6714
			// If we're inactive and not in development mode, sort our box to the top.
6715
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6716
				global $wp_meta_boxes;
6717
6718
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6719
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6720
6721
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6722
			}
6723
		}
6724
	}
6725
6726
	/**
6727
	 * @param mixed $result Value for the user's option
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6728
	 * @return mixed
6729
	 */
6730
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6731
		if ( ! is_array( $sorted ) ) {
6732
			return $sorted;
6733
		}
6734
6735
		foreach ( $sorted as $box_context => $ids ) {
6736
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6737
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6738
				continue;
6739
			}
6740
6741
			$ids_array = explode( ',', $ids );
6742
			$key       = array_search( 'dashboard_stats', $ids_array );
6743
6744
			if ( false !== $key ) {
6745
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6746
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6747
				$sorted[ $box_context ] = implode( ',', $ids_array );
6748
				// We've found it, stop searching, and just return.
6749
				break;
6750
			}
6751
		}
6752
6753
		return $sorted;
6754
	}
6755
6756
	public static function dashboard_widget() {
6757
		/**
6758
		 * Fires when the dashboard is loaded.
6759
		 *
6760
		 * @since 3.4.0
6761
		 */
6762
		do_action( 'jetpack_dashboard_widget' );
6763
	}
6764
6765
	public static function dashboard_widget_footer() {
6766
		?>
6767
		<footer>
6768
6769
		<div class="protect">
6770
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6771
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6772
				<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>
6773
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
6774
				<a href="
6775
				<?php
6776
				echo esc_url(
6777
					wp_nonce_url(
6778
						self::admin_url(
6779
							array(
6780
								'action' => 'activate',
6781
								'module' => 'protect',
6782
							)
6783
						),
6784
						'jetpack_activate-protect'
6785
					)
6786
				);
6787
				?>
6788
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6789
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6790
				</a>
6791
			<?php else : ?>
6792
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6793
			<?php endif; ?>
6794
		</div>
6795
6796
		<div class="akismet">
6797
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6798
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6799
				<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>
6800
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6801
				<a href="
6802
				<?php
6803
				echo esc_url(
6804
					wp_nonce_url(
6805
						add_query_arg(
6806
							array(
6807
								'action' => 'activate',
6808
								'plugin' => 'akismet/akismet.php',
6809
							),
6810
							admin_url( 'plugins.php' )
6811
						),
6812
						'activate-plugin_akismet/akismet.php'
6813
					)
6814
				);
6815
				?>
6816
							" class="button button-jetpack">
6817
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6818
				</a>
6819
			<?php else : ?>
6820
				<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>
6821
			<?php endif; ?>
6822
		</div>
6823
6824
		</footer>
6825
		<?php
6826
	}
6827
6828
	/*
6829
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6830
	 */
6831
	function jetpack_icon_user_connected( $columns ) {
6832
		$columns['user_jetpack'] = '';
6833
		return $columns;
6834
	}
6835
6836
	/*
6837
	 * Show Jetpack icon if the user is linked.
6838
	 */
6839
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6840
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
6841
			$jetpack_logo = new Jetpack_Logo();
6842
			$emblem_html  = sprintf(
6843
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6844
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6845
				$jetpack_logo->get_jp_emblem()
6846
			);
6847
			return $emblem_html;
6848
		}
6849
6850
		return $val;
6851
	}
6852
6853
	/*
6854
	 * Style the Jetpack user column
6855
	 */
6856
	function jetpack_user_col_style() {
6857
		global $current_screen;
6858
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
6859
			?>
6860
			<style>
6861
				.fixed .column-user_jetpack {
6862
					width: 21px;
6863
				}
6864
				.jp-emblem-user-admin svg {
6865
					width: 20px;
6866
					height: 20px;
6867
				}
6868
				.jp-emblem-user-admin path {
6869
					fill: #00BE28;
6870
				}
6871
			</style>
6872
			<?php
6873
		}
6874
	}
6875
6876
	/**
6877
	 * Checks if Akismet is active and working.
6878
	 *
6879
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6880
	 * that implied usage of methods present since more recent version.
6881
	 * See https://github.com/Automattic/jetpack/pull/9585
6882
	 *
6883
	 * @since  5.1.0
6884
	 *
6885
	 * @return bool True = Akismet available. False = Aksimet not available.
6886
	 */
6887
	public static function is_akismet_active() {
6888
		static $status = null;
6889
6890
		if ( ! is_null( $status ) ) {
6891
			return $status;
6892
		}
6893
6894
		// Check if a modern version of Akismet is active.
6895
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6896
			$status = false;
6897
			return $status;
6898
		}
6899
6900
		// Make sure there is a key known to Akismet at all before verifying key.
6901
		$akismet_key = Akismet::get_api_key();
6902
		if ( ! $akismet_key ) {
6903
			$status = false;
6904
			return $status;
6905
		}
6906
6907
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6908
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6909
6910
		// 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.
6911
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6912
		// We cache the result of the Akismet key verification for ten minutes.
6913
		if ( ! $akismet_key_state || $recheck ) {
6914
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6915
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6916
		}
6917
6918
		$status = 'valid' === $akismet_key_state;
6919
6920
		return $status;
6921
	}
6922
6923
	/**
6924
	 * @deprecated
6925
	 *
6926
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
6927
	 */
6928
	public static function is_function_in_backtrace() {
6929
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
6930
	}
6931
6932
	/**
6933
	 * Given a minified path, and a non-minified path, will return
6934
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6935
	 *
6936
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6937
	 * root Jetpack directory.
6938
	 *
6939
	 * @since 5.6.0
6940
	 *
6941
	 * @param string $min_path
6942
	 * @param string $non_min_path
6943
	 * @return string The URL to the file
6944
	 */
6945
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6946
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
6947
	}
6948
6949
	/**
6950
	 * Checks for whether Jetpack Backup & Scan is enabled.
6951
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
6952
	 *
6953
	 * @return bool|int|mixed
6954
	 */
6955
	public static function is_rewind_enabled() {
6956
		if ( ! self::is_active() ) {
6957
			return false;
6958
		}
6959
6960
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6961
		if ( false === $rewind_enabled ) {
6962
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6963
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6964
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
6965
				&& ! empty( $rewind_data['state'] )
6966
				&& 'active' === $rewind_data['state'] )
6967
				? 1
6968
				: 0;
6969
6970
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
6971
		}
6972
		return $rewind_enabled;
6973
	}
6974
6975
	/**
6976
	 * Return Calypso environment value; used for developing Jetpack and pairing
6977
	 * it with different Calypso enrionments, such as localhost.
6978
	 *
6979
	 * @since 7.4.0
6980
	 *
6981
	 * @return string Calypso environment
6982
	 */
6983
	public static function get_calypso_env() {
6984
		if ( isset( $_GET['calypso_env'] ) ) {
6985
			return sanitize_key( $_GET['calypso_env'] );
6986
		}
6987
6988
		if ( getenv( 'CALYPSO_ENV' ) ) {
6989
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
6990
		}
6991
6992
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
6993
			return sanitize_key( CALYPSO_ENV );
6994
		}
6995
6996
		return '';
6997
	}
6998
6999
	/**
7000
	 * Checks whether or not TOS has been agreed upon.
7001
	 * Will return true if a user has clicked to register, or is already connected.
7002
	 */
7003
	public static function jetpack_tos_agreed() {
7004
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7005
7006
		$terms_of_service = new Terms_Of_Service();
7007
		return $terms_of_service->has_agreed();
7008
7009
	}
7010
7011
	/**
7012
	 * Handles activating default modules as well general cleanup for the new connection.
7013
	 *
7014
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7015
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7016
	 * @param boolean $send_state_messages          Whether to send state messages.
7017
	 * @return void
7018
	 */
7019
	public static function handle_post_authorization_actions(
7020
		$activate_sso = false,
7021
		$redirect_on_activation_error = false,
7022
		$send_state_messages = true
7023
	) {
7024
		$other_modules = $activate_sso
7025
			? array( 'sso' )
7026
			: array();
7027
7028
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7029
			self::delete_active_modules();
7030
7031
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
Documentation introduced by
999 is of type integer, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
7032
		} else {
7033
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7034
		}
7035
7036
		// Since this is a fresh connection, be sure to clear out IDC options
7037
		Jetpack_IDC::clear_all_idc_options();
7038
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7039
7040
		// Start nonce cleaner
7041
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7042
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7043
7044
		if ( $send_state_messages ) {
7045
			self::state( 'message', 'authorized' );
7046
		}
7047
	}
7048
7049
	/**
7050
	 * Returns a boolean for whether backups UI should be displayed or not.
7051
	 *
7052
	 * @return bool Should backups UI be displayed?
7053
	 */
7054
	public static function show_backups_ui() {
7055
		/**
7056
		 * Whether UI for backups should be displayed.
7057
		 *
7058
		 * @since 6.5.0
7059
		 *
7060
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7061
		 */
7062
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7063
	}
7064
7065
	/*
7066
	 * Deprecated manage functions
7067
	 */
7068
	function prepare_manage_jetpack_notice() {
7069
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7070
	}
7071
	function manage_activate_screen() {
7072
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7073
	}
7074
	function admin_jetpack_manage_notice() {
7075
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7076
	}
7077
	function opt_out_jetpack_manage_url() {
7078
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7079
	}
7080
	function opt_in_jetpack_manage_url() {
7081
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7082
	}
7083
	function opt_in_jetpack_manage_notice() {
7084
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7085
	}
7086
	function can_display_jetpack_manage_notice() {
7087
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7088
	}
7089
7090
	/**
7091
	 * Clean leftoveruser meta.
7092
	 *
7093
	 * Delete Jetpack-related user meta when it is no longer needed.
7094
	 *
7095
	 * @since 7.3.0
7096
	 *
7097
	 * @param int $user_id User ID being updated.
7098
	 */
7099
	public static function user_meta_cleanup( $user_id ) {
7100
		$meta_keys = array(
7101
			// AtD removed from Jetpack 7.3
7102
			'AtD_options',
7103
			'AtD_check_when',
7104
			'AtD_guess_lang',
7105
			'AtD_ignored_phrases',
7106
		);
7107
7108
		foreach ( $meta_keys as $meta_key ) {
7109
			if ( get_user_meta( $user_id, $meta_key ) ) {
7110
				delete_user_meta( $user_id, $meta_key );
7111
			}
7112
		}
7113
	}
7114
7115
	/**
7116
	 * Checks if a Jetpack site is both active and not in development.
7117
	 *
7118
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7119
	 *
7120
	 * @return bool True if Jetpack is active and not in development.
7121
	 */
7122
	public static function is_active_and_not_development_mode() {
7123
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7124
			return false;
7125
		}
7126
		return true;
7127
	}
7128
}
7129