Completed
Push — try/is-available-in-developmen... ( 04fe8e )
by
unknown
73:58 queued 67:47
created

Jetpack::get_module()   F

Complexity

Conditions 14
Paths 1281

Size

Total Lines 95

Duplication

Lines 12
Ratio 12.63 %

Importance

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