Completed
Push — add/jetpack-login-redirect ( 18c4d6...90c8b1 )
by
unknown
105:24 queued 98:49
created

Jetpack::late_initialization()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 18

Duplication

Lines 0
Ratio 0 %

Importance

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