Completed
Push — update/calendly-embed-code ( 001c02...b82934 )
by
unknown
08:51
created

Jetpack::internal_verify_xml_rpc_signature()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

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