Completed
Push — instant-search-master ( a786a9...893b7c )
by
unknown
85:32 queued 79:17
created

Jetpack::plugin_upgrade()   F

Complexity

Conditions 15
Paths 547

Size

Total Lines 71

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 15
nc 547
nop 0
dl 0
loc 71
rs 2.3791
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

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

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

Commonly applied refactorings include:

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