Completed
Push — update/add_release_post_to_upd... ( c5cd21...960a59 )
by
unknown
38:51 queued 32:38
created

Jetpack::admin_banner_styles()   A

Complexity

Conditions 4
Paths 8

Size

Total Lines 21

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
nc 8
nop 0
dl 0
loc 21
rs 9.584
c 0
b 0
f 0
1
<?php
2
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\Constants;
9
use Automattic\Jetpack\Roles;
10
use Automattic\Jetpack\Sync\Functions;
11
use Automattic\Jetpack\Sync\Sender;
12
use Automattic\Jetpack\Sync\Users;
13
use Automattic\Jetpack\Tracking;
14
use Automattic\Jetpack\Assets;
15
16
/*
17
Options:
18
jetpack_options (array)
19
	An array of options.
20
	@see Jetpack_Options::get_option_names()
21
22
jetpack_register (string)
23
	Temporary verification secrets.
24
25
jetpack_activated (int)
26
	1: the plugin was activated normally
27
	2: the plugin was activated on this site because of a network-wide activation
28
	3: the plugin was auto-installed
29
	4: the plugin was manually disconnected (but is still installed)
30
31
jetpack_active_modules (array)
32
	Array of active module slugs.
33
34
jetpack_do_activate (bool)
35
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
36
*/
37
38
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
39
40
class Jetpack {
41
	public $xmlrpc_server = null;
42
43
	private $rest_authentication_status = null;
44
45
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
46
47
	private $tracking;
48
49
	/**
50
	 * @var array The handles of styles that are concatenated into jetpack.css.
51
	 *
52
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
53
	 */
54
	public $concatenated_style_handles = array(
55
		'jetpack-carousel',
56
		'grunion.css',
57
		'the-neverending-homepage',
58
		'jetpack_likes',
59
		'jetpack_related-posts',
60
		'sharedaddy',
61
		'jetpack-slideshow',
62
		'presentations',
63
		'quiz',
64
		'jetpack-subscriptions',
65
		'jetpack-responsive-videos-style',
66
		'jetpack-social-menu',
67
		'tiled-gallery',
68
		'jetpack_display_posts_widget',
69
		'gravatar-profile-widget',
70
		'goodreads-widget',
71
		'jetpack_social_media_icons_widget',
72
		'jetpack-top-posts-widget',
73
		'jetpack_image_widget',
74
		'jetpack-my-community-widget',
75
		'jetpack-authors-widget',
76
		'wordads',
77
		'eu-cookie-law-style',
78
		'flickr-widget-style',
79
		'jetpack-search-widget',
80
		'jetpack-simple-payments-widget-style',
81
		'jetpack-widget-social-icons-styles',
82
	);
83
84
	/**
85
	 * The handles of scripts that can be loaded asynchronously.
86
	 *
87
	 * @var array
88
	 */
89
	public $async_script_handles = array(
90
		'woocommerce-analytics',
91
	);
92
93
	/**
94
	 * Contains all assets that have had their URL rewritten to minified versions.
95
	 *
96
	 * @var array
97
	 */
98
	static $min_assets = array();
99
100
	public $plugins_to_deactivate = array(
101
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
102
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
103
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
104
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
105
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
106
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
107
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
108
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
109
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
110
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
111
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
112
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
113
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
114
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
115
	);
116
117
	/**
118
	 * Map of roles we care about, and their corresponding minimum capabilities.
119
	 *
120
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
121
	 *
122
	 * @access public
123
	 * @static
124
	 *
125
	 * @var array
126
	 */
127
	public static $capability_translations = array(
128
		'administrator' => 'manage_options',
129
		'editor'        => 'edit_others_posts',
130
		'author'        => 'publish_posts',
131
		'contributor'   => 'edit_posts',
132
		'subscriber'    => 'read',
133
	);
134
135
	/**
136
	 * Map of modules that have conflicts with plugins and should not be auto-activated
137
	 * if the plugins are active.  Used by filter_default_modules
138
	 *
139
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
140
	 * change `module-slug` and add this to your plugin:
141
	 *
142
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
143
	 * function my_jetpack_get_default_modules( $modules ) {
144
	 *     return array_diff( $modules, array( 'module-slug' ) );
145
	 * }
146
	 *
147
	 * @var array
148
	 */
149
	private $conflicting_plugins = array(
150
		'comments'           => array(
151
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
152
			'Disqus'                         => 'disqus-comment-system/disqus.php',
153
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
154
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
155
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
156
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
157
		),
158
		'comment-likes'      => array(
159
			'Epoch' => 'epoch/plugincore.php',
160
		),
161
		'contact-form'       => array(
162
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
163
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
164
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
165
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
166
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
167
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
168
		),
169
		'minileven'          => array(
170
			'WPtouch' => 'wptouch/wptouch.php',
171
		),
172
		'latex'              => array(
173
			'LaTeX for WordPress'     => 'latex/latex.php',
174
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
175
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
176
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
177
			'Enable Latex'            => 'enable-latex/enable-latex.php',
178
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
179
		),
180
		'protect'            => array(
181
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
182
			'Captcha'                           => 'captcha/captcha.php',
183
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
184
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
185
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
186
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
187
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
188
			'Security-protection'               => 'security-protection/security-protection.php',
189
			'Login Security'                    => 'login-security/login-security.php',
190
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
191
			'Wordfence Security'                => 'wordfence/wordfence.php',
192
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
193
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
194
		),
195
		'random-redirect'    => array(
196
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
197
		),
198
		'related-posts'      => array(
199
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
200
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
201
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
202
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
203
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
204
			'outbrain'                    => 'outbrain/outbrain.php',
205
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
206
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
207
		),
208
		'sharedaddy'         => array(
209
			'AddThis'     => 'addthis/addthis_social_widget.php',
210
			'Add To Any'  => 'add-to-any/add-to-any.php',
211
			'ShareThis'   => 'share-this/sharethis.php',
212
			'Shareaholic' => 'shareaholic/shareaholic.php',
213
		),
214
		'seo-tools'          => array(
215
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
216
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
217
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
218
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
219
			'The SEO Framework'              => 'autodescription/autodescription.php',
220
		),
221
		'verification-tools' => array(
222
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
223
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
224
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
225
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
226
			'The SEO Framework'              => 'autodescription/autodescription.php',
227
		),
228
		'widget-visibility'  => array(
229
			'Widget Logic'    => 'widget-logic/widget_logic.php',
230
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
231
		),
232
		'sitemaps'           => array(
233
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
234
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
235
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
236
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
237
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
238
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
239
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
240
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
241
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
242
			'The SEO Framework'                    => 'autodescription/autodescription.php',
243
			'Sitemap'                              => 'sitemap/sitemap.php',
244
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
245
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
246
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
247
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
248
		),
249
		'lazy-images'        => array(
250
			'Lazy Load'              => 'lazy-load/lazy-load.php',
251
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
252
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
253
		),
254
	);
255
256
	/**
257
	 * Plugins for which we turn off our Facebook OG Tags implementation.
258
	 *
259
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
260
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
261
	 *
262
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
263
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
264
	 */
265
	private $open_graph_conflicting_plugins = array(
266
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
267
		// 2 Click Social Media Buttons
268
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
269
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
270
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
271
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
272
		// Open Graph Meta Tags by Heateor
273
		'facebook/facebook.php',                                 // Facebook (official plugin)
274
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
275
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
276
		// Facebook Featured Image & OG Meta Tags
277
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
278
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
279
		// Facebook Open Graph Meta Tags for WordPress
280
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
281
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
282
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
283
		// Fedmich's Facebook Open Graph Meta
284
		'network-publisher/networkpub.php',                      // Network Publisher
285
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
286
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
287
		// NextScripts SNAP
288
		'og-tags/og-tags.php',                                   // OG Tags
289
		'opengraph/opengraph.php',                               // Open Graph
290
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
291
		// Open Graph Protocol Framework
292
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
293
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
294
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
295
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
296
		'sharepress/sharepress.php',                             // SharePress
297
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
298
		'social-discussions/social-discussions.php',             // Social Discussions
299
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
300
		'socialize/socialize.php',                               // Socialize
301
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
302
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
303
		// Tweet, Like, Google +1 and Share
304
		'wordbooker/wordbooker.php',                             // Wordbooker
305
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
306
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
307
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
308
		// WP Facebook Like Send & Open Graph Meta
309
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
310
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
311
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
312
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
313
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
314
	);
315
316
	/**
317
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
318
	 */
319
	private $twitter_cards_conflicting_plugins = array(
320
		// 'twitter/twitter.php',                       // The official one handles this on its own.
321
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
322
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
323
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
324
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
325
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
326
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
327
		'twitter-cards/twitter-cards.php',           // Twitter Cards
328
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
329
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
330
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
331
	);
332
333
	/**
334
	 * Message to display in admin_notice
335
	 *
336
	 * @var string
337
	 */
338
	public $message = '';
339
340
	/**
341
	 * Error to display in admin_notice
342
	 *
343
	 * @var string
344
	 */
345
	public $error = '';
346
347
	/**
348
	 * Modules that need more privacy description.
349
	 *
350
	 * @var string
351
	 */
352
	public $privacy_checks = '';
353
354
	/**
355
	 * Stats to record once the page loads
356
	 *
357
	 * @var array
358
	 */
359
	public $stats = array();
360
361
	/**
362
	 * Jetpack_Sync object
363
	 */
364
	public $sync;
365
366
	/**
367
	 * Verified data for JSON authorization request
368
	 */
369
	public $json_api_authorization_request = array();
370
371
	/**
372
	 * @var Automattic\Jetpack\Connection\Manager
373
	 */
374
	protected $connection_manager;
375
376
	/**
377
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
378
	 */
379
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
380
381
	/**
382
	 * Holds the singleton instance of this class
383
	 *
384
	 * @since 2.3.3
385
	 * @var Jetpack
386
	 */
387
	static $instance = false;
388
389
	/**
390
	 * Singleton
391
	 *
392
	 * @static
393
	 */
394
	public static function init() {
395
		if ( ! self::$instance ) {
396
			self::$instance = new Jetpack();
397
398
			self::$instance->plugin_upgrade();
399
		}
400
401
		return self::$instance;
402
	}
403
404
	/**
405
	 * Must never be called statically
406
	 */
407
	function plugin_upgrade() {
408
		if ( self::is_active() ) {
409
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
410
			if ( JETPACK__VERSION != $version ) {
411
				// Prevent multiple upgrades at once - only a single process should trigger
412
				// an upgrade to avoid stampedes
413
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
414
					return;
415
				}
416
417
				// Set a short lock to prevent multiple instances of the upgrade
418
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
419
420
				// check which active modules actually exist and remove others from active_modules list
421
				$unfiltered_modules = self::get_active_modules();
422
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
423
				if ( array_diff( $unfiltered_modules, $modules ) ) {
424
					self::update_active_modules( $modules );
425
				}
426
427
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
428
429
				// Upgrade to 4.3.0
430
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
431
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
432
				}
433
434
				// Make sure Markdown for posts gets turned back on
435
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
436
					update_option( 'wpcom_publish_posts_with_markdown', true );
437
				}
438
439
				if ( did_action( 'wp_loaded' ) ) {
440
					self::upgrade_on_load();
441
				} else {
442
					add_action(
443
						'wp_loaded',
444
						array( __CLASS__, 'upgrade_on_load' )
445
					);
446
				}
447
			}
448
		}
449
	}
450
451
	/**
452
	 * Runs upgrade routines that need to have modules loaded.
453
	 */
454
	static function upgrade_on_load() {
455
456
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
457
		// This can happen in case Jetpack has been just upgraded and is
458
		// being initialized late during the page load. In this case we wait
459
		// until the next proper admin page load with Jetpack active.
460
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
461
			delete_transient( self::$plugin_upgrade_lock_key );
462
463
			return;
464
		}
465
466
		self::maybe_set_version_option();
467
468
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
469
			Jetpack_Widget_Conditions::migrate_post_type_rules();
470
		}
471
472
		if (
473
			class_exists( 'Jetpack_Sitemap_Manager' )
474
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
475
		) {
476
			do_action( 'jetpack_sitemaps_purge_data' );
477
		}
478
479
		// Delete old stats cache
480
		delete_option( 'jetpack_restapi_stats_cache' );
481
482
		delete_transient( self::$plugin_upgrade_lock_key );
483
	}
484
485
	/**
486
	 * Saves all the currently active modules to options.
487
	 * Also fires Action hooks for each newly activated and deactivated module.
488
	 *
489
	 * @param $modules Array Array of active modules to be saved in options.
490
	 *
491
	 * @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...
492
	 */
493
	static function update_active_modules( $modules ) {
494
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
495
		$active_modules       = self::get_active_modules();
496
		$new_active_modules   = array_diff( $modules, $current_modules );
497
		$new_inactive_modules = array_diff( $active_modules, $modules );
498
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
499
		$reindexed_modules    = array_values( $new_current_modules );
500
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
501
502
		foreach ( $new_active_modules as $module ) {
503
			/**
504
			 * Fires when a specific module is activated.
505
			 *
506
			 * @since 1.9.0
507
			 *
508
			 * @param string $module Module slug.
509
			 * @param boolean $success whether the module was activated. @since 4.2
510
			 */
511
			do_action( 'jetpack_activate_module', $module, $success );
512
			/**
513
			 * Fires when a module is activated.
514
			 * The dynamic part of the filter, $module, is the module slug.
515
			 *
516
			 * @since 1.9.0
517
			 *
518
			 * @param string $module Module slug.
519
			 */
520
			do_action( "jetpack_activate_module_$module", $module );
521
		}
522
523
		foreach ( $new_inactive_modules as $module ) {
524
			/**
525
			 * Fired after a module has been deactivated.
526
			 *
527
			 * @since 4.2.0
528
			 *
529
			 * @param string $module Module slug.
530
			 * @param boolean $success whether the module was deactivated.
531
			 */
532
			do_action( 'jetpack_deactivate_module', $module, $success );
533
			/**
534
			 * Fires when a module is deactivated.
535
			 * The dynamic part of the filter, $module, is the module slug.
536
			 *
537
			 * @since 1.9.0
538
			 *
539
			 * @param string $module Module slug.
540
			 */
541
			do_action( "jetpack_deactivate_module_$module", $module );
542
		}
543
544
		return $success;
545
	}
546
547
	static function delete_active_modules() {
548
		self::update_active_modules( array() );
549
	}
550
551
	/**
552
	 * Constructor.  Initializes WordPress hooks
553
	 */
554
	private function __construct() {
555
		/*
556
		 * Check for and alert any deprecated hooks
557
		 */
558
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
559
560
		/*
561
		 * Enable enhanced handling of previewing sites in Calypso
562
		 */
563
		if ( self::is_active() ) {
564
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
565
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
566
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
567
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
568
		}
569
570
		if ( self::jetpack_tos_agreed() ) {
571
			$tracking = new Automattic\Jetpack\Plugin\Tracking();
572
			add_action( 'init', array( $tracking, 'init' ) );
573
		}
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
	/**
732
	 * Sets up the XMLRPC request handlers.
733
	 *
734
	 * @deprecated since 7.7.0
735
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
736
	 *
737
	 * @param Array                 $request_params Incoming request parameters.
738
	 * @param Boolean               $is_active      Whether the connection is currently active.
739
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
740
	 * @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...
741
	 */
742
	public function setup_xmlrpc_handlers(
743
		$request_params,
744
		$is_active,
745
		$is_signed,
746
		Jetpack_XMLRPC_Server $xmlrpc_server = null
747
	) {
748
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
749
		return $this->connection_manager->setup_xmlrpc_handlers(
750
			$request_params,
751
			$is_active,
752
			$is_signed,
753
			$xmlrpc_server
754
		);
755
	}
756
757
	/**
758
	 * Initialize REST API registration connector.
759
	 *
760
	 * @deprecated since 7.7.0
761
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
762
	 */
763
	public function initialize_rest_api_registration_connector() {
764
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
765
		$this->connection_manager->initialize_rest_api_registration_connector();
766
	}
767
768
	/**
769
	 * This is ported over from the manage module, which has been deprecated and baked in here.
770
	 *
771
	 * @param $domains
772
	 */
773
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
774
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
775
	}
776
777
	/**
778
	 * Return $domains, with 'wordpress.com' appended.
779
	 * This is ported over from the manage module, which has been deprecated and baked in here.
780
	 *
781
	 * @param $domains
782
	 * @return array
783
	 */
784
	function allow_wpcom_domain( $domains ) {
785
		if ( empty( $domains ) ) {
786
			$domains = array();
787
		}
788
		$domains[] = 'wordpress.com';
789
		return array_unique( $domains );
790
	}
791
792
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
793
		$post = get_post( $post_id );
794
795
		if ( empty( $post ) ) {
796
			return $default_url;
797
		}
798
799
		$post_type = $post->post_type;
800
801
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
802
		// https://en.support.wordpress.com/custom-post-types/
803
		$allowed_post_types = array(
804
			'post'                => 'post',
805
			'page'                => 'page',
806
			'jetpack-portfolio'   => 'edit/jetpack-portfolio',
807
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
808
		);
809
810
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
811
			return $default_url;
812
		}
813
814
		$path_prefix = $allowed_post_types[ $post_type ];
815
816
		$site_slug = self::build_raw_urls( get_home_url() );
817
818
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
819
	}
820
821
	function point_edit_comment_links_to_calypso( $url ) {
822
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
823
		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...
824
		return esc_url(
825
			sprintf(
826
				'https://wordpress.com/comment/%s/%d',
827
				self::build_raw_urls( get_home_url() ),
828
				$query_args['amp;c']
829
			)
830
		);
831
	}
832
833
	function jetpack_track_last_sync_callback( $params ) {
834
		/**
835
		 * Filter to turn off jitm caching
836
		 *
837
		 * @since 5.4.0
838
		 *
839
		 * @param bool false Whether to cache just in time messages
840
		 */
841
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
842
			return $params;
843
		}
844
845
		if ( is_array( $params ) && isset( $params[0] ) ) {
846
			$option = $params[0];
847
			if ( 'active_plugins' === $option ) {
848
				// use the cache if we can, but not terribly important if it gets evicted
849
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
850
			}
851
		}
852
853
		return $params;
854
	}
855
856
	function jetpack_connection_banner_callback() {
857
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
858
859
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
860
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
861
			wp_send_json_success();
862
		}
863
864
		wp_die();
865
	}
866
867
	/**
868
	 * Removes all XML-RPC methods that are not `jetpack.*`.
869
	 * Only used in our alternate XML-RPC endpoint, where we want to
870
	 * ensure that Core and other plugins' methods are not exposed.
871
	 *
872
	 * @deprecated since 7.7.0
873
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
874
	 *
875
	 * @param array $methods A list of registered WordPress XMLRPC methods.
876
	 * @return array Filtered $methods
877
	 */
878
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
879
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
880
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
881
	}
882
883
	/**
884
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
885
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
886
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
887
	 * which is accessible via a different URI. Most of the below is copied directly
888
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
889
	 *
890
	 * @deprecated since 7.7.0
891
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
892
	 */
893
	public function alternate_xmlrpc() {
894
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
895
		$this->connection_manager->alternate_xmlrpc();
896
	}
897
898
	/**
899
	 * The callback for the JITM ajax requests.
900
	 *
901
	 * @deprecated since 7.9.0
902
	 */
903
	function jetpack_jitm_ajax_callback() {
904
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
905
	}
906
907
	/**
908
	 * If there are any stats that need to be pushed, but haven't been, push them now.
909
	 */
910
	function push_stats() {
911
		if ( ! empty( $this->stats ) ) {
912
			$this->do_stats( 'server_side' );
913
		}
914
	}
915
916
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
917
		switch ( $cap ) {
918
			case 'jetpack_connect':
919
			case 'jetpack_reconnect':
920
				if ( self::is_development_mode() ) {
921
					$caps = array( 'do_not_allow' );
922
					break;
923
				}
924
				/**
925
				 * Pass through. If it's not development mode, these should match disconnect.
926
				 * Let users disconnect if it's development mode, just in case things glitch.
927
				 */
928
			case 'jetpack_disconnect':
929
				/**
930
				 * In multisite, can individual site admins manage their own connection?
931
				 *
932
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
933
				 */
934
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
935
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
936
						/**
937
						 * We need to update the option name -- it's terribly unclear which
938
						 * direction the override goes.
939
						 *
940
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
941
						 */
942
						$caps = array( 'do_not_allow' );
943
						break;
944
					}
945
				}
946
947
				$caps = array( 'manage_options' );
948
				break;
949
			case 'jetpack_manage_modules':
950
			case 'jetpack_activate_modules':
951
			case 'jetpack_deactivate_modules':
952
				$caps = array( 'manage_options' );
953
				break;
954
			case 'jetpack_configure_modules':
955
				$caps = array( 'manage_options' );
956
				break;
957
			case 'jetpack_manage_autoupdates':
958
				$caps = array(
959
					'manage_options',
960
					'update_plugins',
961
				);
962
				break;
963
			case 'jetpack_network_admin_page':
964
			case 'jetpack_network_settings_page':
965
				$caps = array( 'manage_network_plugins' );
966
				break;
967
			case 'jetpack_network_sites_page':
968
				$caps = array( 'manage_sites' );
969
				break;
970
			case 'jetpack_admin_page':
971
				if ( self::is_development_mode() ) {
972
					$caps = array( 'manage_options' );
973
					break;
974
				} else {
975
					$caps = array( 'read' );
976
				}
977
				break;
978
			case 'jetpack_connect_user':
979
				if ( self::is_development_mode() ) {
980
					$caps = array( 'do_not_allow' );
981
					break;
982
				}
983
				$caps = array( 'read' );
984
				break;
985
		}
986
		return $caps;
987
	}
988
989
	/**
990
	 * Require a Jetpack authentication.
991
	 *
992
	 * @deprecated since 7.7.0
993
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
994
	 */
995
	public function require_jetpack_authentication() {
996
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
997
		$this->connection_manager->require_jetpack_authentication();
998
	}
999
1000
	/**
1001
	 * Load language files
1002
	 *
1003
	 * @action plugins_loaded
1004
	 */
1005
	public static function plugin_textdomain() {
1006
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1007
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1008
	}
1009
1010
	/**
1011
	 * Register assets for use in various modules and the Jetpack admin page.
1012
	 *
1013
	 * @uses wp_script_is, wp_register_script, plugins_url
1014
	 * @action wp_loaded
1015
	 * @return null
1016
	 */
1017
	public function register_assets() {
1018
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1019
			wp_register_script(
1020
				'spin',
1021
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1022
				false,
1023
				'1.3'
1024
			);
1025
		}
1026
1027 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1028
			wp_register_script(
1029
				'jquery.spin',
1030
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1031
				array( 'jquery', 'spin' ),
1032
				'1.3'
1033
			);
1034
		}
1035
1036 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1037
			wp_register_script(
1038
				'jetpack-gallery-settings',
1039
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1040
				array( 'media-views' ),
1041
				'20121225'
1042
			);
1043
		}
1044
1045 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1046
			wp_register_script(
1047
				'jetpack-twitter-timeline',
1048
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1049
				array( 'jquery' ),
1050
				'4.0.0',
1051
				true
1052
			);
1053
		}
1054
1055
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1056
			wp_register_script(
1057
				'jetpack-facebook-embed',
1058
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1059
				array( 'jquery' ),
1060
				null,
1061
				true
1062
			);
1063
1064
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1065
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1066
			if ( ! is_numeric( $fb_app_id ) ) {
1067
				$fb_app_id = '';
1068
			}
1069
			wp_localize_script(
1070
				'jetpack-facebook-embed',
1071
				'jpfbembed',
1072
				array(
1073
					'appid'  => $fb_app_id,
1074
					'locale' => $this->get_locale(),
1075
				)
1076
			);
1077
		}
1078
1079
		/**
1080
		 * As jetpack_register_genericons is by default fired off a hook,
1081
		 * the hook may have already fired by this point.
1082
		 * So, let's just trigger it manually.
1083
		 */
1084
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1085
		jetpack_register_genericons();
1086
1087
		/**
1088
		 * Register the social logos
1089
		 */
1090
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1091
		jetpack_register_social_logos();
1092
1093 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1094
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1095
		}
1096
	}
1097
1098
	/**
1099
	 * Guess locale from language code.
1100
	 *
1101
	 * @param string $lang Language code.
1102
	 * @return string|bool
1103
	 */
1104 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1105
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1106
			return 'en_US';
1107
		}
1108
1109
		if ( ! class_exists( 'GP_Locales' ) ) {
1110
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1111
				return false;
1112
			}
1113
1114
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1115
		}
1116
1117
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1118
			// WP.com: get_locale() returns 'it'
1119
			$locale = GP_Locales::by_slug( $lang );
1120
		} else {
1121
			// Jetpack: get_locale() returns 'it_IT';
1122
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1123
		}
1124
1125
		if ( ! $locale ) {
1126
			return false;
1127
		}
1128
1129
		if ( empty( $locale->facebook_locale ) ) {
1130
			if ( empty( $locale->wp_locale ) ) {
1131
				return false;
1132
			} else {
1133
				// Facebook SDK is smart enough to fall back to en_US if a
1134
				// locale isn't supported. Since supported Facebook locales
1135
				// can fall out of sync, we'll attempt to use the known
1136
				// wp_locale value and rely on said fallback.
1137
				return $locale->wp_locale;
1138
			}
1139
		}
1140
1141
		return $locale->facebook_locale;
1142
	}
1143
1144
	/**
1145
	 * Get the locale.
1146
	 *
1147
	 * @return string|bool
1148
	 */
1149
	function get_locale() {
1150
		$locale = $this->guess_locale_from_lang( get_locale() );
1151
1152
		if ( ! $locale ) {
1153
			$locale = 'en_US';
1154
		}
1155
1156
		return $locale;
1157
	}
1158
1159
	/**
1160
	 * Device Pixels support
1161
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1162
	 */
1163
	function devicepx() {
1164
		if ( self::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1165
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1166
		}
1167
	}
1168
1169
	/**
1170
	 * Return the network_site_url so that .com knows what network this site is a part of.
1171
	 *
1172
	 * @param  bool $option
1173
	 * @return string
1174
	 */
1175
	public function jetpack_main_network_site_option( $option ) {
1176
		return network_site_url();
1177
	}
1178
	/**
1179
	 * Network Name.
1180
	 */
1181
	static function network_name( $option = null ) {
1182
		global $current_site;
1183
		return $current_site->site_name;
1184
	}
1185
	/**
1186
	 * Does the network allow new user and site registrations.
1187
	 *
1188
	 * @return string
1189
	 */
1190
	static function network_allow_new_registrations( $option = null ) {
1191
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1192
	}
1193
	/**
1194
	 * Does the network allow admins to add new users.
1195
	 *
1196
	 * @return boolian
1197
	 */
1198
	static function network_add_new_users( $option = null ) {
1199
		return (bool) get_site_option( 'add_new_users' );
1200
	}
1201
	/**
1202
	 * File upload psace left per site in MB.
1203
	 *  -1 means NO LIMIT.
1204
	 *
1205
	 * @return number
1206
	 */
1207
	static function network_site_upload_space( $option = null ) {
1208
		// value in MB
1209
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1210
	}
1211
1212
	/**
1213
	 * Network allowed file types.
1214
	 *
1215
	 * @return string
1216
	 */
1217
	static function network_upload_file_types( $option = null ) {
1218
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1219
	}
1220
1221
	/**
1222
	 * Maximum file upload size set by the network.
1223
	 *
1224
	 * @return number
1225
	 */
1226
	static function network_max_upload_file_size( $option = null ) {
1227
		// value in KB
1228
		return get_site_option( 'fileupload_maxk', 300 );
1229
	}
1230
1231
	/**
1232
	 * Lets us know if a site allows admins to manage the network.
1233
	 *
1234
	 * @return array
1235
	 */
1236
	static function network_enable_administration_menus( $option = null ) {
1237
		return get_site_option( 'menu_items' );
1238
	}
1239
1240
	/**
1241
	 * If a user has been promoted to or demoted from admin, we need to clear the
1242
	 * jetpack_other_linked_admins transient.
1243
	 *
1244
	 * @since 4.3.2
1245
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1246
	 *
1247
	 * @param int    $user_id   The user ID whose role changed.
1248
	 * @param string $role      The new role.
1249
	 * @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...
1250
	 */
1251
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1252
		if ( 'administrator' == $role
1253
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1254
			|| is_null( $old_roles )
1255
		) {
1256
			delete_transient( 'jetpack_other_linked_admins' );
1257
		}
1258
	}
1259
1260
	/**
1261
	 * Checks to see if there are any other users available to become primary
1262
	 * Users must both:
1263
	 * - Be linked to wpcom
1264
	 * - Be an admin
1265
	 *
1266
	 * @return mixed False if no other users are linked, Int if there are.
1267
	 */
1268
	static function get_other_linked_admins() {
1269
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1270
1271
		if ( false === $other_linked_users ) {
1272
			$admins = get_users( array( 'role' => 'administrator' ) );
1273
			if ( count( $admins ) > 1 ) {
1274
				$available = array();
1275
				foreach ( $admins as $admin ) {
1276
					if ( self::is_user_connected( $admin->ID ) ) {
1277
						$available[] = $admin->ID;
1278
					}
1279
				}
1280
1281
				$count_connected_admins = count( $available );
1282
				if ( count( $available ) > 1 ) {
1283
					$other_linked_users = $count_connected_admins;
1284
				} else {
1285
					$other_linked_users = 0;
1286
				}
1287
			} else {
1288
				$other_linked_users = 0;
1289
			}
1290
1291
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1292
		}
1293
1294
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1295
	}
1296
1297
	/**
1298
	 * Return whether we are dealing with a multi network setup or not.
1299
	 * The reason we are type casting this is because we want to avoid the situation where
1300
	 * the result is false since when is_main_network_option return false it cases
1301
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1302
	 * database which could be set to anything as opposed to what this function returns.
1303
	 *
1304
	 * @param  bool $option
1305
	 *
1306
	 * @return boolean
1307
	 */
1308
	public function is_main_network_option( $option ) {
1309
		// return '1' or ''
1310
		return (string) (bool) self::is_multi_network();
1311
	}
1312
1313
	/**
1314
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1315
	 *
1316
	 * @param  string $option
1317
	 * @return boolean
1318
	 */
1319
	public function is_multisite( $option ) {
1320
		return (string) (bool) is_multisite();
1321
	}
1322
1323
	/**
1324
	 * Implemented since there is no core is multi network function
1325
	 * Right now there is no way to tell if we which network is the dominant network on the system
1326
	 *
1327
	 * @since  3.3
1328
	 * @return boolean
1329
	 */
1330 View Code Duplication
	public static function is_multi_network() {
1331
		global  $wpdb;
1332
1333
		// if we don't have a multi site setup no need to do any more
1334
		if ( ! is_multisite() ) {
1335
			return false;
1336
		}
1337
1338
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1339
		if ( $num_sites > 1 ) {
1340
			return true;
1341
		} else {
1342
			return false;
1343
		}
1344
	}
1345
1346
	/**
1347
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1348
	 *
1349
	 * @return null
1350
	 */
1351
	function update_jetpack_main_network_site_option() {
1352
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1353
	}
1354
	/**
1355
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1356
	 */
1357
	function update_jetpack_network_settings() {
1358
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1359
		// Only sync this info for the main network site.
1360
	}
1361
1362
	/**
1363
	 * Get back if the current site is single user site.
1364
	 *
1365
	 * @return bool
1366
	 */
1367 View Code Duplication
	public static function is_single_user_site() {
1368
		global $wpdb;
1369
1370
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1371
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1372
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1373
		}
1374
		return 1 === (int) $some_users;
1375
	}
1376
1377
	/**
1378
	 * Returns true if the site has file write access false otherwise.
1379
	 *
1380
	 * @return string ( '1' | '0' )
1381
	 **/
1382
	public static function file_system_write_access() {
1383
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1384
			require_once ABSPATH . 'wp-admin/includes/file.php';
1385
		}
1386
1387
		require_once ABSPATH . 'wp-admin/includes/template.php';
1388
1389
		$filesystem_method = get_filesystem_method();
1390
		if ( $filesystem_method === 'direct' ) {
1391
			return 1;
1392
		}
1393
1394
		ob_start();
1395
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1396
		ob_end_clean();
1397
		if ( $filesystem_credentials_are_stored ) {
1398
			return 1;
1399
		}
1400
		return 0;
1401
	}
1402
1403
	/**
1404
	 * Finds out if a site is using a version control system.
1405
	 *
1406
	 * @return string ( '1' | '0' )
1407
	 **/
1408
	public static function is_version_controlled() {
1409
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1410
		return (string) (int) Functions::is_version_controlled();
1411
	}
1412
1413
	/**
1414
	 * Determines whether the current theme supports featured images or not.
1415
	 *
1416
	 * @return string ( '1' | '0' )
1417
	 */
1418
	public static function featured_images_enabled() {
1419
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1420
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1421
	}
1422
1423
	/**
1424
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1425
	 *
1426
	 * @deprecated 4.7 use get_avatar_url instead.
1427
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1428
	 * @param int               $size Size of the avatar image
1429
	 * @param string            $default URL to a default image to use if no avatar is available
1430
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1431
	 *
1432
	 * @return array
1433
	 */
1434
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1435
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1436
		return get_avatar_url(
1437
			$id_or_email,
1438
			array(
1439
				'size'          => $size,
1440
				'default'       => $default,
1441
				'force_default' => $force_display,
1442
			)
1443
		);
1444
	}
1445
1446
	/**
1447
	 * jetpack_updates is saved in the following schema:
1448
	 *
1449
	 * array (
1450
	 *      'plugins'                       => (int) Number of plugin updates available.
1451
	 *      'themes'                        => (int) Number of theme updates available.
1452
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1453
	 *      'translations'                  => (int) Number of translation updates available.
1454
	 *      'total'                         => (int) Total of all available updates.
1455
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1456
	 * )
1457
	 *
1458
	 * @return array
1459
	 */
1460
	public static function get_updates() {
1461
		$update_data = wp_get_update_data();
1462
1463
		// Stores the individual update counts as well as the total count.
1464
		if ( isset( $update_data['counts'] ) ) {
1465
			$updates = $update_data['counts'];
1466
		}
1467
1468
		// If we need to update WordPress core, let's find the latest version number.
1469 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1470
			$cur = get_preferred_from_update_core();
1471
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1472
				$updates['wp_update_version'] = $cur->current;
1473
			}
1474
		}
1475
		return isset( $updates ) ? $updates : array();
1476
	}
1477
1478
	public static function get_update_details() {
1479
		$update_details = array(
1480
			'update_core'    => get_site_transient( 'update_core' ),
1481
			'update_plugins' => get_site_transient( 'update_plugins' ),
1482
			'update_themes'  => get_site_transient( 'update_themes' ),
1483
		);
1484
		return $update_details;
1485
	}
1486
1487
	public static function refresh_update_data() {
1488
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1489
1490
	}
1491
1492
	public static function refresh_theme_data() {
1493
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1494
	}
1495
1496
	/**
1497
	 * Is Jetpack active?
1498
	 */
1499
	public static function is_active() {
1500
		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...
1501
	}
1502
1503
	/**
1504
	 * Make an API call to WordPress.com for plan status
1505
	 *
1506
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1507
	 *
1508
	 * @return bool True if plan is updated, false if no update
1509
	 */
1510
	public static function refresh_active_plan_from_wpcom() {
1511
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1512
		return Jetpack_Plan::refresh_from_wpcom();
1513
	}
1514
1515
	/**
1516
	 * Get the plan that this Jetpack site is currently using
1517
	 *
1518
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1519
	 * @return array Active Jetpack plan details.
1520
	 */
1521
	public static function get_active_plan() {
1522
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1523
		return Jetpack_Plan::get();
1524
	}
1525
1526
	/**
1527
	 * Determine whether the active plan supports a particular feature
1528
	 *
1529
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1530
	 * @return bool True if plan supports feature, false if not.
1531
	 */
1532
	public static function active_plan_supports( $feature ) {
1533
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1534
		return Jetpack_Plan::supports( $feature );
1535
	}
1536
1537
	/**
1538
	 * Is Jetpack in development (offline) mode?
1539
	 */
1540 View Code Duplication
	public static function is_development_mode() {
1541
		$development_mode = false;
1542
1543
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1544
			$development_mode = JETPACK_DEV_DEBUG;
1545
		} elseif ( $site_url = site_url() ) {
1546
			$development_mode = false === strpos( $site_url, '.' );
1547
		}
1548
1549
		/**
1550
		 * Filters Jetpack's development mode.
1551
		 *
1552
		 * @see https://jetpack.com/support/development-mode/
1553
		 *
1554
		 * @since 2.2.1
1555
		 *
1556
		 * @param bool $development_mode Is Jetpack's development mode active.
1557
		 */
1558
		$development_mode = (bool) apply_filters( 'jetpack_development_mode', $development_mode );
1559
		return $development_mode;
1560
	}
1561
1562
	/**
1563
	 * Whether the site is currently onboarding or not.
1564
	 * A site is considered as being onboarded if it currently has an onboarding token.
1565
	 *
1566
	 * @since 5.8
1567
	 *
1568
	 * @access public
1569
	 * @static
1570
	 *
1571
	 * @return bool True if the site is currently onboarding, false otherwise
1572
	 */
1573
	public static function is_onboarding() {
1574
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1575
	}
1576
1577
	/**
1578
	 * Determines reason for Jetpack development mode.
1579
	 */
1580
	public static function development_mode_trigger_text() {
1581
		if ( ! self::is_development_mode() ) {
1582
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1583
		}
1584
1585
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1586
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1587
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1588
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1589
		} else {
1590
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1591
		}
1592
1593
		return $notice;
1594
1595
	}
1596
	/**
1597
	 * Get Jetpack development mode notice text and notice class.
1598
	 *
1599
	 * Mirrors the checks made in Jetpack::is_development_mode
1600
	 */
1601
	public static function show_development_mode_notice() {
1602 View Code Duplication
		if ( self::is_development_mode() ) {
1603
			$notice = sprintf(
1604
				/* translators: %s is a URL */
1605
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1606
				'https://jetpack.com/support/development-mode/'
1607
			);
1608
1609
			$notice .= ' ' . self::development_mode_trigger_text();
1610
1611
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1612
		}
1613
1614
		// Throw up a notice if using a development version and as for feedback.
1615
		if ( self::is_development_version() ) {
1616
			/* translators: %s is a URL */
1617
			$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/' );
1618
1619
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1620
		}
1621
		// Throw up a notice if using staging mode
1622
		if ( self::is_staging_site() ) {
1623
			/* translators: %s is a URL */
1624
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1625
1626
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1627
		}
1628
	}
1629
1630
	/**
1631
	 * Whether Jetpack's version maps to a public release, or a development version.
1632
	 */
1633
	public static function is_development_version() {
1634
		/**
1635
		 * Allows filtering whether this is a development version of Jetpack.
1636
		 *
1637
		 * This filter is especially useful for tests.
1638
		 *
1639
		 * @since 4.3.0
1640
		 *
1641
		 * @param bool $development_version Is this a develoment version of Jetpack?
1642
		 */
1643
		return (bool) apply_filters(
1644
			'jetpack_development_version',
1645
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1646
		);
1647
	}
1648
1649
	/**
1650
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1651
	 */
1652
	public static function is_user_connected( $user_id = false ) {
1653
		return self::connection()->is_user_connected( $user_id );
1654
	}
1655
1656
	/**
1657
	 * Get the wpcom user data of the current|specified connected user.
1658
	 */
1659 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1660
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1661
		if ( ! $user_id ) {
1662
			$user_id = get_current_user_id();
1663
		}
1664
1665
		$transient_key = "jetpack_connected_user_data_$user_id";
1666
1667
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1668
			return $cached_user_data;
1669
		}
1670
1671
		$xml = new Jetpack_IXR_Client(
1672
			array(
1673
				'user_id' => $user_id,
1674
			)
1675
		);
1676
		$xml->query( 'wpcom.getUser' );
1677
		if ( ! $xml->isError() ) {
1678
			$user_data = $xml->getResponse();
1679
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1680
			return $user_data;
1681
		}
1682
1683
		return false;
1684
	}
1685
1686
	/**
1687
	 * Get the wpcom email of the current|specified connected user.
1688
	 */
1689 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1690
		if ( ! $user_id ) {
1691
			$user_id = get_current_user_id();
1692
		}
1693
1694
		$xml = new Jetpack_IXR_Client(
1695
			array(
1696
				'user_id' => $user_id,
1697
			)
1698
		);
1699
		$xml->query( 'wpcom.getUserEmail' );
1700
		if ( ! $xml->isError() ) {
1701
			return $xml->getResponse();
1702
		}
1703
		return false;
1704
	}
1705
1706
	/**
1707
	 * Get the wpcom email of the master user.
1708
	 */
1709
	public static function get_master_user_email() {
1710
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1711
		if ( $master_user_id ) {
1712
			return self::get_connected_user_email( $master_user_id );
1713
		}
1714
		return '';
1715
	}
1716
1717
	/**
1718
	 * Whether the current user is the connection owner.
1719
	 *
1720
	 * @deprecated since 7.7
1721
	 *
1722
	 * @return bool Whether the current user is the connection owner.
1723
	 */
1724
	public function current_user_is_connection_owner() {
1725
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1726
		return self::connection()->is_connection_owner();
1727
	}
1728
1729
	/**
1730
	 * Gets current user IP address.
1731
	 *
1732
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1733
	 *
1734
	 * @return string                  Current user IP address.
1735
	 */
1736
	public static function current_user_ip( $check_all_headers = false ) {
1737
		if ( $check_all_headers ) {
1738
			foreach ( array(
1739
				'HTTP_CF_CONNECTING_IP',
1740
				'HTTP_CLIENT_IP',
1741
				'HTTP_X_FORWARDED_FOR',
1742
				'HTTP_X_FORWARDED',
1743
				'HTTP_X_CLUSTER_CLIENT_IP',
1744
				'HTTP_FORWARDED_FOR',
1745
				'HTTP_FORWARDED',
1746
				'HTTP_VIA',
1747
			) as $key ) {
1748
				if ( ! empty( $_SERVER[ $key ] ) ) {
1749
					return $_SERVER[ $key ];
1750
				}
1751
			}
1752
		}
1753
1754
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1755
	}
1756
1757
	/**
1758
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1759
	 */
1760
	function extra_oembed_providers() {
1761
		// Cloudup: https://dev.cloudup.com/#oembed
1762
		wp_oembed_add_provider( 'https://cloudup.com/*', 'https://cloudup.com/oembed' );
1763
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1764
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1765
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1766
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1767
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1768
		wp_oembed_add_provider( 'https://song.link/*', 'https://song.link/oembed', false );
1769
	}
1770
1771
	/**
1772
	 * Synchronize connected user role changes
1773
	 */
1774
	function user_role_change( $user_id ) {
1775
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1776
		Users::user_role_change( $user_id );
1777
	}
1778
1779
	/**
1780
	 * Loads the currently active modules.
1781
	 */
1782
	public static function load_modules() {
1783
		if (
1784
			! self::is_active()
1785
			&& ! self::is_development_mode()
1786
			&& ! self::is_onboarding()
1787
			&& (
1788
				! is_multisite()
1789
				|| ! get_site_option( 'jetpack_protect_active' )
1790
			)
1791
		) {
1792
			return;
1793
		}
1794
1795
		$version = Jetpack_Options::get_option( 'version' );
1796 View Code Duplication
		if ( ! $version ) {
1797
			$version = $old_version = JETPACK__VERSION . ':' . time();
1798
			/** This action is documented in class.jetpack.php */
1799
			do_action( 'updating_jetpack_version', $version, false );
1800
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1801
		}
1802
		list( $version ) = explode( ':', $version );
1803
1804
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1805
1806
		$modules_data = array();
1807
1808
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1809
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1810
			$updated_modules = array();
1811
			foreach ( $modules as $module ) {
1812
				$modules_data[ $module ] = self::get_module( $module );
1813
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1814
					continue;
1815
				}
1816
1817
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1818
					continue;
1819
				}
1820
1821
				$updated_modules[] = $module;
1822
			}
1823
1824
			$modules = array_diff( $modules, $updated_modules );
1825
		}
1826
1827
		$is_development_mode = self::is_development_mode();
1828
1829
		foreach ( $modules as $index => $module ) {
1830
			// If we're in dev mode, disable modules requiring a connection
1831
			if ( $is_development_mode ) {
1832
				// Prime the pump if we need to
1833
				if ( empty( $modules_data[ $module ] ) ) {
1834
					$modules_data[ $module ] = self::get_module( $module );
1835
				}
1836
				// If the module requires a connection, but we're in local mode, don't include it.
1837
				if ( $modules_data[ $module ]['requires_connection'] ) {
1838
					continue;
1839
				}
1840
			}
1841
1842
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1843
				continue;
1844
			}
1845
1846
			if ( ! include_once self::get_module_path( $module ) ) {
1847
				unset( $modules[ $index ] );
1848
				self::update_active_modules( array_values( $modules ) );
1849
				continue;
1850
			}
1851
1852
			/**
1853
			 * Fires when a specific module is loaded.
1854
			 * The dynamic part of the hook, $module, is the module slug.
1855
			 *
1856
			 * @since 1.1.0
1857
			 */
1858
			do_action( 'jetpack_module_loaded_' . $module );
1859
		}
1860
1861
		/**
1862
		 * Fires when all the modules are loaded.
1863
		 *
1864
		 * @since 1.1.0
1865
		 */
1866
		do_action( 'jetpack_modules_loaded' );
1867
1868
		// 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.
1869
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1870
	}
1871
1872
	/**
1873
	 * Check if Jetpack's REST API compat file should be included
1874
	 *
1875
	 * @action plugins_loaded
1876
	 * @return null
1877
	 */
1878
	public function check_rest_api_compat() {
1879
		/**
1880
		 * Filters the list of REST API compat files to be included.
1881
		 *
1882
		 * @since 2.2.5
1883
		 *
1884
		 * @param array $args Array of REST API compat files to include.
1885
		 */
1886
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1887
1888
		if ( function_exists( 'bbpress' ) ) {
1889
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1890
		}
1891
1892
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1893
			require_once $_jetpack_rest_api_compat_include;
1894
		}
1895
	}
1896
1897
	/**
1898
	 * Gets all plugins currently active in values, regardless of whether they're
1899
	 * traditionally activated or network activated.
1900
	 *
1901
	 * @todo Store the result in core's object cache maybe?
1902
	 */
1903
	public static function get_active_plugins() {
1904
		$active_plugins = (array) get_option( 'active_plugins', array() );
1905
1906
		if ( is_multisite() ) {
1907
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1908
			// whereas active_plugins stores them in the values.
1909
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1910
			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...
1911
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1912
			}
1913
		}
1914
1915
		sort( $active_plugins );
1916
1917
		return array_unique( $active_plugins );
1918
	}
1919
1920
	/**
1921
	 * Gets and parses additional plugin data to send with the heartbeat data
1922
	 *
1923
	 * @since 3.8.1
1924
	 *
1925
	 * @return array Array of plugin data
1926
	 */
1927
	public static function get_parsed_plugin_data() {
1928
		if ( ! function_exists( 'get_plugins' ) ) {
1929
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
1930
		}
1931
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1932
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1933
		$active_plugins = self::get_active_plugins();
1934
1935
		$plugins = array();
1936
		foreach ( $all_plugins as $path => $plugin_data ) {
1937
			$plugins[ $path ] = array(
1938
				'is_active' => in_array( $path, $active_plugins ),
1939
				'file'      => $path,
1940
				'name'      => $plugin_data['Name'],
1941
				'version'   => $plugin_data['Version'],
1942
				'author'    => $plugin_data['Author'],
1943
			);
1944
		}
1945
1946
		return $plugins;
1947
	}
1948
1949
	/**
1950
	 * Gets and parses theme data to send with the heartbeat data
1951
	 *
1952
	 * @since 3.8.1
1953
	 *
1954
	 * @return array Array of theme data
1955
	 */
1956
	public static function get_parsed_theme_data() {
1957
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
1958
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1959
1960
		$themes = array();
1961
		foreach ( $all_themes as $slug => $theme_data ) {
1962
			$theme_headers = array();
1963
			foreach ( $header_keys as $header_key ) {
1964
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1965
			}
1966
1967
			$themes[ $slug ] = array(
1968
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
1969
				'slug'            => $slug,
1970
				'theme_root'      => $theme_data->get_theme_root_uri(),
1971
				'parent'          => $theme_data->parent(),
1972
				'headers'         => $theme_headers,
1973
			);
1974
		}
1975
1976
		return $themes;
1977
	}
1978
1979
	/**
1980
	 * Checks whether a specific plugin is active.
1981
	 *
1982
	 * We don't want to store these in a static variable, in case
1983
	 * there are switch_to_blog() calls involved.
1984
	 */
1985
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1986
		return in_array( $plugin, self::get_active_plugins() );
1987
	}
1988
1989
	/**
1990
	 * Check if Jetpack's Open Graph tags should be used.
1991
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1992
	 *
1993
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1994
	 * @action plugins_loaded
1995
	 * @return null
1996
	 */
1997
	public function check_open_graph() {
1998
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
1999
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2000
		}
2001
2002
		$active_plugins = self::get_active_plugins();
2003
2004
		if ( ! empty( $active_plugins ) ) {
2005
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2006
				if ( in_array( $plugin, $active_plugins ) ) {
2007
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2008
					break;
2009
				}
2010
			}
2011
		}
2012
2013
		/**
2014
		 * Allow the addition of Open Graph Meta Tags to all pages.
2015
		 *
2016
		 * @since 2.0.3
2017
		 *
2018
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2019
		 */
2020
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2021
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2022
		}
2023
	}
2024
2025
	/**
2026
	 * Check if Jetpack's Twitter tags should be used.
2027
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2028
	 *
2029
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2030
	 * @action plugins_loaded
2031
	 * @return null
2032
	 */
2033
	public function check_twitter_tags() {
2034
2035
		$active_plugins = self::get_active_plugins();
2036
2037
		if ( ! empty( $active_plugins ) ) {
2038
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2039
				if ( in_array( $plugin, $active_plugins ) ) {
2040
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2041
					break;
2042
				}
2043
			}
2044
		}
2045
2046
		/**
2047
		 * Allow Twitter Card Meta tags to be disabled.
2048
		 *
2049
		 * @since 2.6.0
2050
		 *
2051
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2052
		 */
2053
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2054
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2055
		}
2056
	}
2057
2058
	/**
2059
	 * Allows plugins to submit security reports.
2060
	 *
2061
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2062
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2063
	 * @param array  $args         See definitions above
2064
	 */
2065
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2066
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2067
	}
2068
2069
	/* Jetpack Options API */
2070
2071
	public static function get_option_names( $type = 'compact' ) {
2072
		return Jetpack_Options::get_option_names( $type );
2073
	}
2074
2075
	/**
2076
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2077
	 *
2078
	 * @param string $name    Option name
2079
	 * @param mixed  $default (optional)
2080
	 */
2081
	public static function get_option( $name, $default = false ) {
2082
		return Jetpack_Options::get_option( $name, $default );
2083
	}
2084
2085
	/**
2086
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2087
	 *
2088
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2089
	 * @param string $name  Option name
2090
	 * @param mixed  $value Option value
2091
	 */
2092
	public static function update_option( $name, $value ) {
2093
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2094
		return Jetpack_Options::update_option( $name, $value );
2095
	}
2096
2097
	/**
2098
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2099
	 *
2100
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2101
	 * @param array $array array( option name => option value, ... )
2102
	 */
2103
	public static function update_options( $array ) {
2104
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2105
		return Jetpack_Options::update_options( $array );
2106
	}
2107
2108
	/**
2109
	 * Deletes the given option.  May be passed multiple option names as an array.
2110
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2111
	 *
2112
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2113
	 * @param string|array $names
2114
	 */
2115
	public static function delete_option( $names ) {
2116
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2117
		return Jetpack_Options::delete_option( $names );
2118
	}
2119
2120
	/**
2121
	 * Enters a user token into the user_tokens option
2122
	 *
2123
	 * @param int    $user_id
2124
	 * @param string $token
2125
	 * return bool
2126
	 */
2127
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2128
		// not designed for concurrent updates
2129
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2130
		if ( ! is_array( $user_tokens ) ) {
2131
			$user_tokens = array();
2132
		}
2133
		$user_tokens[ $user_id ] = $token;
2134
		if ( $is_master_user ) {
2135
			$master_user = $user_id;
2136
			$options     = compact( 'user_tokens', 'master_user' );
2137
		} else {
2138
			$options = compact( 'user_tokens' );
2139
		}
2140
		return Jetpack_Options::update_options( $options );
2141
	}
2142
2143
	/**
2144
	 * Returns an array of all PHP files in the specified absolute path.
2145
	 * Equivalent to glob( "$absolute_path/*.php" ).
2146
	 *
2147
	 * @param string $absolute_path The absolute path of the directory to search.
2148
	 * @return array Array of absolute paths to the PHP files.
2149
	 */
2150
	public static function glob_php( $absolute_path ) {
2151
		if ( function_exists( 'glob' ) ) {
2152
			return glob( "$absolute_path/*.php" );
2153
		}
2154
2155
		$absolute_path = untrailingslashit( $absolute_path );
2156
		$files         = array();
2157
		if ( ! $dir = @opendir( $absolute_path ) ) {
2158
			return $files;
2159
		}
2160
2161
		while ( false !== $file = readdir( $dir ) ) {
2162
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2163
				continue;
2164
			}
2165
2166
			$file = "$absolute_path/$file";
2167
2168
			if ( ! is_file( $file ) ) {
2169
				continue;
2170
			}
2171
2172
			$files[] = $file;
2173
		}
2174
2175
		closedir( $dir );
2176
2177
		return $files;
2178
	}
2179
2180
	public static function activate_new_modules( $redirect = false ) {
2181
		if ( ! self::is_active() && ! self::is_development_mode() ) {
2182
			return;
2183
		}
2184
2185
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2186 View Code Duplication
		if ( ! $jetpack_old_version ) {
2187
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2188
			/** This action is documented in class.jetpack.php */
2189
			do_action( 'updating_jetpack_version', $version, false );
2190
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2191
		}
2192
2193
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2194
2195
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2196
			return;
2197
		}
2198
2199
		$active_modules     = self::get_active_modules();
2200
		$reactivate_modules = array();
2201
		foreach ( $active_modules as $active_module ) {
2202
			$module = self::get_module( $active_module );
2203
			if ( ! isset( $module['changed'] ) ) {
2204
				continue;
2205
			}
2206
2207
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2208
				continue;
2209
			}
2210
2211
			$reactivate_modules[] = $active_module;
2212
			self::deactivate_module( $active_module );
2213
		}
2214
2215
		$new_version = JETPACK__VERSION . ':' . time();
2216
		/** This action is documented in class.jetpack.php */
2217
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2218
		Jetpack_Options::update_options(
2219
			array(
2220
				'version'     => $new_version,
2221
				'old_version' => $jetpack_old_version,
2222
			)
2223
		);
2224
2225
		self::state( 'message', 'modules_activated' );
2226
2227
		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...
2228
2229
		if ( $redirect ) {
2230
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2231
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2232
				$page = $_GET['page'];
2233
			}
2234
2235
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2236
			exit;
2237
		}
2238
	}
2239
2240
	/**
2241
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2242
	 * Make sure to tuck away module "library" files in a sub-directory.
2243
	 */
2244
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2245
		static $modules = null;
2246
2247
		if ( ! isset( $modules ) ) {
2248
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2249
			// Use the cache if we're on the front-end and it's available...
2250
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2251
				$modules = $available_modules_option[ JETPACK__VERSION ];
2252
			} else {
2253
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2254
2255
				$modules = array();
2256
2257
				foreach ( $files as $file ) {
2258
					if ( ! $headers = self::get_module( $file ) ) {
2259
						continue;
2260
					}
2261
2262
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2263
				}
2264
2265
				Jetpack_Options::update_option(
2266
					'available_modules',
2267
					array(
2268
						JETPACK__VERSION => $modules,
2269
					)
2270
				);
2271
			}
2272
		}
2273
2274
		/**
2275
		 * Filters the array of modules available to be activated.
2276
		 *
2277
		 * @since 2.4.0
2278
		 *
2279
		 * @param array $modules Array of available modules.
2280
		 * @param string $min_version Minimum version number required to use modules.
2281
		 * @param string $max_version Maximum version number required to use modules.
2282
		 */
2283
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2284
2285
		if ( ! $min_version && ! $max_version ) {
2286
			return array_keys( $mods );
2287
		}
2288
2289
		$r = array();
2290
		foreach ( $mods as $slug => $introduced ) {
2291
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2292
				continue;
2293
			}
2294
2295
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2296
				continue;
2297
			}
2298
2299
			$r[] = $slug;
2300
		}
2301
2302
		return $r;
2303
	}
2304
2305
	/**
2306
	 * Default modules loaded on activation.
2307
	 */
2308
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2309
		$return = array();
2310
2311
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2312
			$module_data = self::get_module( $module );
2313
2314
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2315
				case 'yes':
2316
					$return[] = $module;
2317
					break;
2318
				case 'public':
2319
					if ( Jetpack_Options::get_option( 'public' ) ) {
2320
						$return[] = $module;
2321
					}
2322
					break;
2323
				case 'no':
2324
				default:
2325
					break;
2326
			}
2327
		}
2328
		/**
2329
		 * Filters the array of default modules.
2330
		 *
2331
		 * @since 2.5.0
2332
		 *
2333
		 * @param array $return Array of default modules.
2334
		 * @param string $min_version Minimum version number required to use modules.
2335
		 * @param string $max_version Maximum version number required to use modules.
2336
		 */
2337
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2338
	}
2339
2340
	/**
2341
	 * Checks activated modules during auto-activation to determine
2342
	 * if any of those modules are being deprecated.  If so, close
2343
	 * them out, and add any replacement modules.
2344
	 *
2345
	 * Runs at priority 99 by default.
2346
	 *
2347
	 * This is run late, so that it can still activate a module if
2348
	 * the new module is a replacement for another that the user
2349
	 * currently has active, even if something at the normal priority
2350
	 * would kibosh everything.
2351
	 *
2352
	 * @since 2.6
2353
	 * @uses jetpack_get_default_modules filter
2354
	 * @param array $modules
2355
	 * @return array
2356
	 */
2357
	function handle_deprecated_modules( $modules ) {
2358
		$deprecated_modules = array(
2359
			'debug'            => null,  // Closed out and moved to the debugger library.
2360
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2361
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2362
		);
2363
2364
		// Don't activate SSO if they never completed activating WPCC.
2365
		if ( self::is_module_active( 'wpcc' ) ) {
2366
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2367
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2368
				$deprecated_modules['wpcc'] = null;
2369
			}
2370
		}
2371
2372
		foreach ( $deprecated_modules as $module => $replacement ) {
2373
			if ( self::is_module_active( $module ) ) {
2374
				self::deactivate_module( $module );
2375
				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...
2376
					$modules[] = $replacement;
2377
				}
2378
			}
2379
		}
2380
2381
		return array_unique( $modules );
2382
	}
2383
2384
	/**
2385
	 * Checks activated plugins during auto-activation to determine
2386
	 * if any of those plugins are in the list with a corresponding module
2387
	 * that is not compatible with the plugin. The module will not be allowed
2388
	 * to auto-activate.
2389
	 *
2390
	 * @since 2.6
2391
	 * @uses jetpack_get_default_modules filter
2392
	 * @param array $modules
2393
	 * @return array
2394
	 */
2395
	function filter_default_modules( $modules ) {
2396
2397
		$active_plugins = self::get_active_plugins();
2398
2399
		if ( ! empty( $active_plugins ) ) {
2400
2401
			// For each module we'd like to auto-activate...
2402
			foreach ( $modules as $key => $module ) {
2403
				// If there are potential conflicts for it...
2404
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2405
					// For each potential conflict...
2406
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2407
						// If that conflicting plugin is active...
2408
						if ( in_array( $plugin, $active_plugins ) ) {
2409
							// Remove that item from being auto-activated.
2410
							unset( $modules[ $key ] );
2411
						}
2412
					}
2413
				}
2414
			}
2415
		}
2416
2417
		return $modules;
2418
	}
2419
2420
	/**
2421
	 * Extract a module's slug from its full path.
2422
	 */
2423
	public static function get_module_slug( $file ) {
2424
		return str_replace( '.php', '', basename( $file ) );
2425
	}
2426
2427
	/**
2428
	 * Generate a module's path from its slug.
2429
	 */
2430
	public static function get_module_path( $slug ) {
2431
		/**
2432
		 * Filters the path of a modules.
2433
		 *
2434
		 * @since 7.4.0
2435
		 *
2436
		 * @param array $return The absolute path to a module's root php file
2437
		 * @param string $slug The module slug
2438
		 */
2439
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2440
	}
2441
2442
	/**
2443
	 * Load module data from module file. Headers differ from WordPress
2444
	 * plugin headers to avoid them being identified as standalone
2445
	 * plugins on the WordPress plugins page.
2446
	 */
2447
	public static function get_module( $module ) {
2448
		$headers = array(
2449
			'name'                      => 'Module Name',
2450
			'description'               => 'Module Description',
2451
			'sort'                      => 'Sort Order',
2452
			'recommendation_order'      => 'Recommendation Order',
2453
			'introduced'                => 'First Introduced',
2454
			'changed'                   => 'Major Changes In',
2455
			'deactivate'                => 'Deactivate',
2456
			'free'                      => 'Free',
2457
			'requires_connection'       => 'Requires Connection',
2458
			'auto_activate'             => 'Auto Activate',
2459
			'module_tags'               => 'Module Tags',
2460
			'feature'                   => 'Feature',
2461
			'additional_search_queries' => 'Additional Search Queries',
2462
			'plan_classes'              => 'Plans',
2463
		);
2464
2465
		$file = self::get_module_path( self::get_module_slug( $module ) );
2466
2467
		$mod = self::get_file_data( $file, $headers );
2468
		if ( empty( $mod['name'] ) ) {
2469
			return false;
2470
		}
2471
2472
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2473
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2474
		$mod['deactivate']           = empty( $mod['deactivate'] );
2475
		$mod['free']                 = empty( $mod['free'] );
2476
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2477
2478
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2479
			$mod['auto_activate'] = 'No';
2480
		} else {
2481
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2482
		}
2483
2484
		if ( $mod['module_tags'] ) {
2485
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2486
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2487
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2488
		} else {
2489
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2490
		}
2491
2492 View Code Duplication
		if ( $mod['plan_classes'] ) {
2493
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2494
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2495
		} else {
2496
			$mod['plan_classes'] = array( 'free' );
2497
		}
2498
2499 View Code Duplication
		if ( $mod['feature'] ) {
2500
			$mod['feature'] = explode( ',', $mod['feature'] );
2501
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2502
		} else {
2503
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2504
		}
2505
2506
		/**
2507
		 * Filters the feature array on a module.
2508
		 *
2509
		 * This filter allows you to control where each module is filtered: Recommended,
2510
		 * and the default "Other" listing.
2511
		 *
2512
		 * @since 3.5.0
2513
		 *
2514
		 * @param array   $mod['feature'] The areas to feature this module:
2515
		 *     'Recommended' shows on the main Jetpack admin screen.
2516
		 *     'Other' should be the default if no other value is in the array.
2517
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2518
		 * @param array   $mod All the currently assembled module data.
2519
		 */
2520
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2521
2522
		/**
2523
		 * Filter the returned data about a module.
2524
		 *
2525
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2526
		 * so please be careful.
2527
		 *
2528
		 * @since 3.6.0
2529
		 *
2530
		 * @param array   $mod    The details of the requested module.
2531
		 * @param string  $module The slug of the module, e.g. sharedaddy
2532
		 * @param string  $file   The path to the module source file.
2533
		 */
2534
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2535
	}
2536
2537
	/**
2538
	 * Like core's get_file_data implementation, but caches the result.
2539
	 */
2540
	public static function get_file_data( $file, $headers ) {
2541
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2542
		$file_name = basename( $file );
2543
2544
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2545
2546
		$file_data_option = get_transient( $cache_key );
2547
2548
		if ( ! is_array( $file_data_option ) ) {
2549
			delete_transient( $cache_key );
2550
			$file_data_option = false;
2551
		}
2552
2553
		if ( false === $file_data_option ) {
2554
			$file_data_option = array();
2555
		}
2556
2557
		$key           = md5( $file_name . serialize( $headers ) );
2558
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2559
2560
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2561
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2562
			return $file_data_option[ $key ];
2563
		}
2564
2565
		$data = get_file_data( $file, $headers );
2566
2567
		$file_data_option[ $key ] = $data;
2568
2569
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2570
2571
		return $data;
2572
	}
2573
2574
2575
	/**
2576
	 * Return translated module tag.
2577
	 *
2578
	 * @param string $tag Tag as it appears in each module heading.
2579
	 *
2580
	 * @return mixed
2581
	 */
2582
	public static function translate_module_tag( $tag ) {
2583
		return jetpack_get_module_i18n_tag( $tag );
2584
	}
2585
2586
	/**
2587
	 * Get i18n strings as a JSON-encoded string
2588
	 *
2589
	 * @return string The locale as JSON
2590
	 */
2591
	public static function get_i18n_data_json() {
2592
2593
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2594
		// JSON files with the file they should be included for. This is an md5
2595
		// of '_inc/build/admin.js'.
2596
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2597
2598
		$i18n_json =
2599
				   JETPACK__PLUGIN_DIR
2600
				   . 'languages/json/jetpack-'
2601
				   . get_user_locale()
2602
				   . '-'
2603
				   . $path_md5
2604
				   . '.json';
2605
2606
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2607
			$locale_data = @file_get_contents( $i18n_json );
2608
			if ( $locale_data ) {
2609
				return $locale_data;
2610
			}
2611
		}
2612
2613
		// Return valid empty Jed locale
2614
		return '{ "locale_data": { "messages": { "": {} } } }';
2615
	}
2616
2617
	/**
2618
	 * Add locale data setup to wp-i18n
2619
	 *
2620
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2621
	 *
2622
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2623
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2624
	 *
2625
	 * This method provides a safe way to request the setup multiple times but add the script at
2626
	 * most once.
2627
	 *
2628
	 * @since 6.7.0
2629
	 *
2630
	 * @return void
2631
	 */
2632
	public static function setup_wp_i18n_locale_data() {
2633
		static $script_added = false;
2634
		if ( ! $script_added ) {
2635
			$script_added = true;
2636
			wp_add_inline_script(
2637
				'wp-i18n',
2638
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2639
			);
2640
		}
2641
	}
2642
2643
	/**
2644
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2645
	 *
2646
	 * @since 3.9.2
2647
	 *
2648
	 * @param array $modules
2649
	 *
2650
	 * @return string|void
2651
	 */
2652
	public static function get_translated_modules( $modules ) {
2653
		foreach ( $modules as $index => $module ) {
2654
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2655
			if ( isset( $module['name'] ) ) {
2656
				$modules[ $index ]['name'] = $i18n_module['name'];
2657
			}
2658
			if ( isset( $module['description'] ) ) {
2659
				$modules[ $index ]['description']       = $i18n_module['description'];
2660
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2661
			}
2662
		}
2663
		return $modules;
2664
	}
2665
2666
	/**
2667
	 * Get a list of activated modules as an array of module slugs.
2668
	 */
2669
	public static function get_active_modules() {
2670
		$active = Jetpack_Options::get_option( 'active_modules' );
2671
2672
		if ( ! is_array( $active ) ) {
2673
			$active = array();
2674
		}
2675
2676
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2677
			$active[] = 'vaultpress';
2678
		} else {
2679
			$active = array_diff( $active, array( 'vaultpress' ) );
2680
		}
2681
2682
		// If protect is active on the main site of a multisite, it should be active on all sites.
2683
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2684
			$active[] = 'protect';
2685
		}
2686
2687
		/**
2688
		 * Allow filtering of the active modules.
2689
		 *
2690
		 * Gives theme and plugin developers the power to alter the modules that
2691
		 * are activated on the fly.
2692
		 *
2693
		 * @since 5.8.0
2694
		 *
2695
		 * @param array $active Array of active module slugs.
2696
		 */
2697
		$active = apply_filters( 'jetpack_active_modules', $active );
2698
2699
		return array_unique( $active );
2700
	}
2701
2702
	/**
2703
	 * Check whether or not a Jetpack module is active.
2704
	 *
2705
	 * @param string $module The slug of a Jetpack module.
2706
	 * @return bool
2707
	 *
2708
	 * @static
2709
	 */
2710
	public static function is_module_active( $module ) {
2711
		return in_array( $module, self::get_active_modules() );
2712
	}
2713
2714
	public static function is_module( $module ) {
2715
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2716
	}
2717
2718
	/**
2719
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2720
	 *
2721
	 * @param bool $catch True to start catching, False to stop.
2722
	 *
2723
	 * @static
2724
	 */
2725
	public static function catch_errors( $catch ) {
2726
		static $display_errors, $error_reporting;
2727
2728
		if ( $catch ) {
2729
			$display_errors  = @ini_set( 'display_errors', 1 );
2730
			$error_reporting = @error_reporting( E_ALL );
2731
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2732
		} else {
2733
			@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...
2734
			@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...
2735
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2736
		}
2737
	}
2738
2739
	/**
2740
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2741
	 */
2742
	public static function catch_errors_on_shutdown() {
2743
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2744
	}
2745
2746
	/**
2747
	 * Rewrite any string to make paths easier to read.
2748
	 *
2749
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2750
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2751
	 *
2752
	 * @param $string
2753
	 * @return mixed
2754
	 */
2755
	public static function alias_directories( $string ) {
2756
		// ABSPATH has a trailing slash.
2757
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2758
		// WP_CONTENT_DIR does not have a trailing slash.
2759
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2760
2761
		return $string;
2762
	}
2763
2764
	public static function activate_default_modules(
2765
		$min_version = false,
2766
		$max_version = false,
2767
		$other_modules = array(),
2768
		$redirect = null,
2769
		$send_state_messages = null
2770
	) {
2771
		$jetpack = self::init();
2772
2773
		if ( is_null( $redirect ) ) {
2774
			if (
2775
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2776
			||
2777
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2778
			||
2779
				( defined( 'WP_CLI' ) && WP_CLI )
2780
			||
2781
				( defined( 'DOING_CRON' ) && DOING_CRON )
2782
			||
2783
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2784
			) {
2785
				$redirect = false;
2786
			} elseif ( is_admin() ) {
2787
				$redirect = true;
2788
			} else {
2789
				$redirect = false;
2790
			}
2791
		}
2792
2793
		if ( is_null( $send_state_messages ) ) {
2794
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2795
		}
2796
2797
		$modules = self::get_default_modules( $min_version, $max_version );
2798
		$modules = array_merge( $other_modules, $modules );
2799
2800
		// Look for standalone plugins and disable if active.
2801
2802
		$to_deactivate = array();
2803
		foreach ( $modules as $module ) {
2804
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2805
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2806
			}
2807
		}
2808
2809
		$deactivated = array();
2810
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2811
			list( $probable_file, $probable_title ) = $deactivate_me;
2812
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2813
				$deactivated[] = $module;
2814
			}
2815
		}
2816
2817
		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...
2818
			if ( $send_state_messages ) {
2819
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2820
			}
2821
2822
			if ( $redirect ) {
2823
				$url = add_query_arg(
2824
					array(
2825
						'action'   => 'activate_default_modules',
2826
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2827
					),
2828
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2829
				);
2830
				wp_safe_redirect( $url );
2831
				exit;
2832
			}
2833
		}
2834
2835
		/**
2836
		 * Fires before default modules are activated.
2837
		 *
2838
		 * @since 1.9.0
2839
		 *
2840
		 * @param string $min_version Minimum version number required to use modules.
2841
		 * @param string $max_version Maximum version number required to use modules.
2842
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2843
		 */
2844
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2845
2846
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2847
		if ( $send_state_messages ) {
2848
			self::restate();
2849
			self::catch_errors( true );
2850
		}
2851
2852
		$active = self::get_active_modules();
2853
2854
		foreach ( $modules as $module ) {
2855
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2856
				$active[] = $module;
2857
				self::update_active_modules( $active );
2858
				continue;
2859
			}
2860
2861
			if ( $send_state_messages && in_array( $module, $active ) ) {
2862
				$module_info = self::get_module( $module );
2863 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2864
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2865
					if ( $active_state = self::state( $state ) ) {
2866
						$active_state = explode( ',', $active_state );
2867
					} else {
2868
						$active_state = array();
2869
					}
2870
					$active_state[] = $module;
2871
					self::state( $state, implode( ',', $active_state ) );
2872
				}
2873
				continue;
2874
			}
2875
2876
			$file = self::get_module_path( $module );
2877
			if ( ! file_exists( $file ) ) {
2878
				continue;
2879
			}
2880
2881
			// we'll override this later if the plugin can be included without fatal error
2882
			if ( $redirect ) {
2883
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2884
			}
2885
2886
			if ( $send_state_messages ) {
2887
				self::state( 'error', 'module_activation_failed' );
2888
				self::state( 'module', $module );
2889
			}
2890
2891
			ob_start();
2892
			require_once $file;
2893
2894
			$active[] = $module;
2895
2896 View Code Duplication
			if ( $send_state_messages ) {
2897
2898
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2899
				if ( $active_state = self::state( $state ) ) {
2900
					$active_state = explode( ',', $active_state );
2901
				} else {
2902
					$active_state = array();
2903
				}
2904
				$active_state[] = $module;
2905
				self::state( $state, implode( ',', $active_state ) );
2906
			}
2907
2908
			self::update_active_modules( $active );
2909
2910
			ob_end_clean();
2911
		}
2912
2913
		if ( $send_state_messages ) {
2914
			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...
2915
			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...
2916
		}
2917
2918
		self::catch_errors( false );
2919
		/**
2920
		 * Fires when default modules are activated.
2921
		 *
2922
		 * @since 1.9.0
2923
		 *
2924
		 * @param string $min_version Minimum version number required to use modules.
2925
		 * @param string $max_version Maximum version number required to use modules.
2926
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2927
		 */
2928
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2929
	}
2930
2931
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2932
		/**
2933
		 * Fires before a module is activated.
2934
		 *
2935
		 * @since 2.6.0
2936
		 *
2937
		 * @param string $module Module slug.
2938
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2939
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2940
		 */
2941
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2942
2943
		$jetpack = self::init();
2944
2945
		if ( ! strlen( $module ) ) {
2946
			return false;
2947
		}
2948
2949
		if ( ! self::is_module( $module ) ) {
2950
			return false;
2951
		}
2952
2953
		// If it's already active, then don't do it again
2954
		$active = self::get_active_modules();
2955
		foreach ( $active as $act ) {
2956
			if ( $act == $module ) {
2957
				return true;
2958
			}
2959
		}
2960
2961
		$module_data = self::get_module( $module );
2962
2963
		if ( ! self::is_active() ) {
2964
			if ( ! self::is_development_mode() && ! self::is_onboarding() ) {
2965
				return false;
2966
			}
2967
2968
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2969
			if ( self::is_development_mode() && $module_data['requires_connection'] ) {
2970
				return false;
2971
			}
2972
		}
2973
2974
		// Check and see if the old plugin is active
2975
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2976
			// Deactivate the old plugin
2977
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2978
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2979
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2980
				self::state( 'deactivated_plugins', $module );
2981
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2982
				exit;
2983
			}
2984
		}
2985
2986
		// Protect won't work with mis-configured IPs
2987
		if ( 'protect' === $module ) {
2988
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2989
			if ( ! jetpack_protect_get_ip() ) {
2990
				self::state( 'message', 'protect_misconfigured_ip' );
2991
				return false;
2992
			}
2993
		}
2994
2995
		if ( ! Jetpack_Plan::supports( $module ) ) {
2996
			return false;
2997
		}
2998
2999
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3000
		self::state( 'module', $module );
3001
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3002
3003
		self::catch_errors( true );
3004
		ob_start();
3005
		require self::get_module_path( $module );
3006
		/** This action is documented in class.jetpack.php */
3007
		do_action( 'jetpack_activate_module', $module );
3008
		$active[] = $module;
3009
		self::update_active_modules( $active );
3010
3011
		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...
3012
		ob_end_clean();
3013
		self::catch_errors( false );
3014
3015
		if ( $redirect ) {
3016
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3017
		}
3018
		if ( $exit ) {
3019
			exit;
3020
		}
3021
		return true;
3022
	}
3023
3024
	function activate_module_actions( $module ) {
3025
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3026
	}
3027
3028
	public static function deactivate_module( $module ) {
3029
		/**
3030
		 * Fires when a module is deactivated.
3031
		 *
3032
		 * @since 1.9.0
3033
		 *
3034
		 * @param string $module Module slug.
3035
		 */
3036
		do_action( 'jetpack_pre_deactivate_module', $module );
3037
3038
		$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...
3039
3040
		$active = self::get_active_modules();
3041
		$new    = array_filter( array_diff( $active, (array) $module ) );
3042
3043
		return self::update_active_modules( $new );
3044
	}
3045
3046
	public static function enable_module_configurable( $module ) {
3047
		$module = self::get_module_slug( $module );
3048
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3049
	}
3050
3051
	/**
3052
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3053
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3054
	 *
3055
	 * @param string $module Module slug
3056
	 * @return string $url module configuration URL
3057
	 */
3058
	public static function module_configuration_url( $module ) {
3059
		$module      = self::get_module_slug( $module );
3060
		$default_url = self::admin_url() . "#/settings?term=$module";
3061
		/**
3062
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3063
		 *
3064
		 * @since 6.9.0
3065
		 *
3066
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3067
		 */
3068
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3069
3070
		return $url;
3071
	}
3072
3073
	/* Installation */
3074
	public static function bail_on_activation( $message, $deactivate = true ) {
3075
		?>
3076
<!doctype html>
3077
<html>
3078
<head>
3079
<meta charset="<?php bloginfo( 'charset' ); ?>">
3080
<style>
3081
* {
3082
	text-align: center;
3083
	margin: 0;
3084
	padding: 0;
3085
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3086
}
3087
p {
3088
	margin-top: 1em;
3089
	font-size: 18px;
3090
}
3091
</style>
3092
<body>
3093
<p><?php echo esc_html( $message ); ?></p>
3094
</body>
3095
</html>
3096
		<?php
3097
		if ( $deactivate ) {
3098
			$plugins = get_option( 'active_plugins' );
3099
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3100
			$update  = false;
3101
			foreach ( $plugins as $i => $plugin ) {
3102
				if ( $plugin === $jetpack ) {
3103
					$plugins[ $i ] = false;
3104
					$update        = true;
3105
				}
3106
			}
3107
3108
			if ( $update ) {
3109
				update_option( 'active_plugins', array_filter( $plugins ) );
3110
			}
3111
		}
3112
		exit;
3113
	}
3114
3115
	/**
3116
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3117
	 *
3118
	 * @static
3119
	 */
3120
	public static function plugin_activation( $network_wide ) {
3121
		Jetpack_Options::update_option( 'activated', 1 );
3122
3123
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3124
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3125
		}
3126
3127
		if ( $network_wide ) {
3128
			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...
3129
		}
3130
3131
		// For firing one-off events (notices) immediately after activation
3132
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3133
3134
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3135
3136
		self::plugin_initialize();
3137
	}
3138
3139
	public static function get_activation_source( $referer_url ) {
3140
3141
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3142
			return array( 'wp-cli', null );
3143
		}
3144
3145
		$referer = parse_url( $referer_url );
3146
3147
		$source_type  = 'unknown';
3148
		$source_query = null;
3149
3150
		if ( ! is_array( $referer ) ) {
3151
			return array( $source_type, $source_query );
3152
		}
3153
3154
		$plugins_path         = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3155
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3156
3157
		if ( isset( $referer['query'] ) ) {
3158
			parse_str( $referer['query'], $query_parts );
3159
		} else {
3160
			$query_parts = array();
3161
		}
3162
3163
		if ( $plugins_path === $referer['path'] ) {
3164
			$source_type = 'list';
3165
		} elseif ( $plugins_install_path === $referer['path'] ) {
3166
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3167
			switch ( $tab ) {
3168
				case 'popular':
3169
					$source_type = 'popular';
3170
					break;
3171
				case 'recommended':
3172
					$source_type = 'recommended';
3173
					break;
3174
				case 'favorites':
3175
					$source_type = 'favorites';
3176
					break;
3177
				case 'search':
3178
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3179
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3180
					break;
3181
				default:
3182
					$source_type = 'featured';
3183
			}
3184
		}
3185
3186
		return array( $source_type, $source_query );
3187
	}
3188
3189
	/**
3190
	 * Runs before bumping version numbers up to a new version
3191
	 *
3192
	 * @param string $version    Version:timestamp.
3193
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3194
	 */
3195
	public static function do_version_bump( $version, $old_version ) {
3196
		if ( $old_version ) { // For existing Jetpack installations.
3197
			self::send_update_modal_data();
3198
		}
3199
	}
3200
3201
	/**
3202
	 * Prepares the release post content and image data and saves it in the
3203
	 * state array. This data is used to create the update modal.
3204
	 */
3205
	public static function send_update_modal_data() {
3206
		$response = wp_remote_get( 'https://public-api.wordpress.com/rest/v1/sites/jetpack.com/posts/?order_by=date&category=Releases&number=1' );
3207
		if ( ! is_array( $response ) ) {
3208
			return;
3209
		}
3210
3211
		$post_data = json_decode( wp_remote_retrieve_body( $response ), true );
3212
3213
		if ( ! isset( $post_data['posts'] ) || ! isset( $post_data['posts'][0] ) ) {
3214
			return;
3215
		}
3216
3217
		$post_content = isset( $post_data['posts'][0]['content'] ) ? $post_data['posts'][0]['content'] : null;
3218
		if ( empty( $post_content ) ) {
3219
			return;
3220
		}
3221
		$post_image_src = isset( $post_data['posts'][0]['featured_image'] ) ? $post_data['posts'][0]['featured_image'] : null;
3222
3223
		$content   = wp_kses_post( $post_content );
3224
		$image_src = esc_url( $post_image_src );
3225
3226
		$post_array = array(
3227
			'release_post_content' => $content,
3228
			'release_post_image'   => $image_src,
3229
		);
3230
3231
		self::state( 'message_content', wp_json_encode( $post_array ) );
3232
	}
3233
3234
	/**
3235
	 * Sets the internal version number and activation state.
3236
	 *
3237
	 * @static
3238
	 */
3239
	public static function plugin_initialize() {
3240
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3241
			Jetpack_Options::update_option( 'activated', 2 );
3242
		}
3243
3244 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3245
			$version = $old_version = JETPACK__VERSION . ':' . time();
3246
			/** This action is documented in class.jetpack.php */
3247
			do_action( 'updating_jetpack_version', $version, false );
3248
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3249
		}
3250
3251
		self::load_modules();
3252
3253
		Jetpack_Options::delete_option( 'do_activate' );
3254
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3255
	}
3256
3257
	/**
3258
	 * Removes all connection options
3259
	 *
3260
	 * @static
3261
	 */
3262
	public static function plugin_deactivation() {
3263
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3264
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3265
			Jetpack_Network::init()->deactivate();
3266
		} else {
3267
			self::disconnect( false );
3268
			// Jetpack_Heartbeat::init()->deactivate();
3269
		}
3270
	}
3271
3272
	/**
3273
	 * Disconnects from the Jetpack servers.
3274
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3275
	 *
3276
	 * @static
3277
	 */
3278
	public static function disconnect( $update_activated_state = true ) {
3279
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3280
		$connection = self::connection();
3281
		$connection->clean_nonces( true );
3282
3283
		// If the site is in an IDC because sync is not allowed,
3284
		// let's make sure to not disconnect the production site.
3285
		if ( ! self::validate_sync_error_idc_option() ) {
3286
			$tracking = new Tracking();
3287
			$tracking->record_user_event( 'disconnect_site', array() );
3288
3289
			$xml = new Jetpack_IXR_Client();
3290
			$xml->query( 'jetpack.deregister', get_current_user_id() );
3291
		}
3292
3293
		Jetpack_Options::delete_option(
3294
			array(
3295
				'blog_token',
3296
				'user_token',
3297
				'user_tokens',
3298
				'master_user',
3299
				'time_diff',
3300
				'fallback_no_verify_ssl_certs',
3301
			)
3302
		);
3303
3304
		Jetpack_IDC::clear_all_idc_options();
3305
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3306
3307
		if ( $update_activated_state ) {
3308
			Jetpack_Options::update_option( 'activated', 4 );
3309
		}
3310
3311
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3312
			// Check then record unique disconnection if site has never been disconnected previously
3313
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3314
				$jetpack_unique_connection['disconnected'] = 1;
3315
			} else {
3316
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3317
					// track unique disconnect
3318
					$jetpack = self::init();
3319
3320
					$jetpack->stat( 'connections', 'unique-disconnect' );
3321
					$jetpack->do_stats( 'server_side' );
3322
				}
3323
				// increment number of times disconnected
3324
				$jetpack_unique_connection['disconnected'] += 1;
3325
			}
3326
3327
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3328
		}
3329
3330
		// Delete cached connected user data
3331
		$transient_key = 'jetpack_connected_user_data_' . get_current_user_id();
3332
		delete_transient( $transient_key );
3333
3334
		// Delete all the sync related data. Since it could be taking up space.
3335
		Sender::get_instance()->uninstall();
3336
3337
		// Disable the Heartbeat cron
3338
		Jetpack_Heartbeat::init()->deactivate();
3339
	}
3340
3341
	/**
3342
	 * Unlinks the current user from the linked WordPress.com user.
3343
	 *
3344
	 * @deprecated since 7.7
3345
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3346
	 *
3347
	 * @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...
3348
	 * @return Boolean Whether the disconnection of the user was successful.
3349
	 */
3350
	public static function unlink_user( $user_id = null ) {
3351
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3352
		return Connection_Manager::disconnect_user( $user_id );
3353
	}
3354
3355
	/**
3356
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3357
	 */
3358
	public static function try_registration() {
3359
		// The user has agreed to the TOS at some point by now.
3360
		Jetpack_Options::update_option( 'tos_agreed', true );
3361
3362
		// Let's get some testing in beta versions and such.
3363
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3364
			// Before attempting to connect, let's make sure that the domains are viable.
3365
			$domains_to_check = array_unique(
3366
				array(
3367
					'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3368
					'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3369
				)
3370
			);
3371
			foreach ( $domains_to_check as $domain ) {
3372
				$result = self::connection()->is_usable_domain( $domain );
0 ignored issues
show
Security Bug introduced by
It seems like $domain defined by $domain on line 3371 can also be of type false; however, Automattic\Jetpack\Conne...ger::is_usable_domain() does only seem to accept string, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
3373
				if ( is_wp_error( $result ) ) {
3374
					return $result;
3375
				}
3376
			}
3377
		}
3378
3379
		$result = self::register();
3380
3381
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3382
		if ( ! $result || is_wp_error( $result ) ) {
3383
			return $result;
3384
		} else {
3385
			return true;
3386
		}
3387
	}
3388
3389
	/**
3390
	 * Tracking an internal event log. Try not to put too much chaff in here.
3391
	 *
3392
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3393
	 */
3394
	public static function log( $code, $data = null ) {
3395
		// only grab the latest 200 entries
3396
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3397
3398
		// Append our event to the log
3399
		$log_entry = array(
3400
			'time'    => time(),
3401
			'user_id' => get_current_user_id(),
3402
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3403
			'code'    => $code,
3404
		);
3405
		// Don't bother storing it unless we've got some.
3406
		if ( ! is_null( $data ) ) {
3407
			$log_entry['data'] = $data;
3408
		}
3409
		$log[] = $log_entry;
3410
3411
		// Try add_option first, to make sure it's not autoloaded.
3412
		// @todo: Add an add_option method to Jetpack_Options
3413
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3414
			Jetpack_Options::update_option( 'log', $log );
3415
		}
3416
3417
		/**
3418
		 * Fires when Jetpack logs an internal event.
3419
		 *
3420
		 * @since 3.0.0
3421
		 *
3422
		 * @param array $log_entry {
3423
		 *  Array of details about the log entry.
3424
		 *
3425
		 *  @param string time Time of the event.
3426
		 *  @param int user_id ID of the user who trigerred the event.
3427
		 *  @param int blog_id Jetpack Blog ID.
3428
		 *  @param string code Unique name for the event.
3429
		 *  @param string data Data about the event.
3430
		 * }
3431
		 */
3432
		do_action( 'jetpack_log_entry', $log_entry );
3433
	}
3434
3435
	/**
3436
	 * Get the internal event log.
3437
	 *
3438
	 * @param $event (string) - only return the specific log events
3439
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3440
	 *
3441
	 * @return array of log events || WP_Error for invalid params
3442
	 */
3443
	public static function get_log( $event = false, $num = false ) {
3444
		if ( $event && ! is_string( $event ) ) {
3445
			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...
3446
		}
3447
3448
		if ( $num && ! is_numeric( $num ) ) {
3449
			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...
3450
		}
3451
3452
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3453
3454
		// If nothing set - act as it did before, otherwise let's start customizing the output
3455
		if ( ! $num && ! $event ) {
3456
			return $entire_log;
3457
		} else {
3458
			$entire_log = array_reverse( $entire_log );
3459
		}
3460
3461
		$custom_log_output = array();
3462
3463
		if ( $event ) {
3464
			foreach ( $entire_log as $log_event ) {
3465
				if ( $event == $log_event['code'] ) {
3466
					$custom_log_output[] = $log_event;
3467
				}
3468
			}
3469
		} else {
3470
			$custom_log_output = $entire_log;
3471
		}
3472
3473
		if ( $num ) {
3474
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3475
		}
3476
3477
		return $custom_log_output;
3478
	}
3479
3480
	/**
3481
	 * Log modification of important settings.
3482
	 */
3483
	public static function log_settings_change( $option, $old_value, $value ) {
3484
		switch ( $option ) {
3485
			case 'jetpack_sync_non_public_post_stati':
3486
				self::log( $option, $value );
3487
				break;
3488
		}
3489
	}
3490
3491
	/**
3492
	 * Return stat data for WPCOM sync
3493
	 */
3494
	public static function get_stat_data( $encode = true, $extended = true ) {
3495
		$data = Jetpack_Heartbeat::generate_stats_array();
3496
3497
		if ( $extended ) {
3498
			$additional_data = self::get_additional_stat_data();
3499
			$data            = array_merge( $data, $additional_data );
3500
		}
3501
3502
		if ( $encode ) {
3503
			return json_encode( $data );
3504
		}
3505
3506
		return $data;
3507
	}
3508
3509
	/**
3510
	 * Get additional stat data to sync to WPCOM
3511
	 */
3512
	public static function get_additional_stat_data( $prefix = '' ) {
3513
		$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...
3514
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3515
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3516
		$return[ "{$prefix}site-count" ]    = 0;
3517
3518
		if ( function_exists( 'get_blog_count' ) ) {
3519
			$return[ "{$prefix}site-count" ] = get_blog_count();
3520
		}
3521
		return $return;
3522
	}
3523
3524
	private static function get_site_user_count() {
3525
		global $wpdb;
3526
3527
		if ( function_exists( 'wp_is_large_network' ) ) {
3528
			if ( wp_is_large_network( 'users' ) ) {
3529
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3530
			}
3531
		}
3532
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3533
			// It wasn't there, so regenerate the data and save the transient
3534
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3535
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3536
		}
3537
		return $user_count;
3538
	}
3539
3540
	/* Admin Pages */
3541
3542
	function admin_init() {
3543
		// If the plugin is not connected, display a connect message.
3544
		if (
3545
			// the plugin was auto-activated and needs its candy
3546
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3547
		||
3548
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3549
			! Jetpack_Options::get_option( 'activated' )
3550
		) {
3551
			self::plugin_initialize();
3552
		}
3553
3554
		if ( ! self::is_active() && ! self::is_development_mode() ) {
3555
			Jetpack_Connection_Banner::init();
3556
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3557
			// Upgrade: 1.1 -> 1.1.1
3558
			// Check and see if host can verify the Jetpack servers' SSL certificate
3559
			$args       = array();
3560
			$connection = self::connection();
3561
			Client::_wp_remote_request(
3562
				self::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3563
				$args,
3564
				true
3565
			);
3566
		}
3567
3568
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3569
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3570
		}
3571
3572
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3573
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3574
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3575
3576
		if ( self::is_active() || self::is_development_mode() ) {
3577
			// Artificially throw errors in certain whitelisted cases during plugin activation
3578
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3579
		}
3580
3581
		// Add custom column in wp-admin/users.php to show whether user is linked.
3582
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3583
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3584
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3585
	}
3586
3587
	function admin_body_class( $admin_body_class = '' ) {
3588
		$classes = explode( ' ', trim( $admin_body_class ) );
3589
3590
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3591
3592
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3593
		return " $admin_body_class ";
3594
	}
3595
3596
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3597
		return $admin_body_class . ' jetpack-pagestyles ';
3598
	}
3599
3600
	/**
3601
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3602
	 * This function artificially throws errors for such cases (whitelisted).
3603
	 *
3604
	 * @param string $plugin The activated plugin.
3605
	 */
3606
	function throw_error_on_activate_plugin( $plugin ) {
3607
		$active_modules = self::get_active_modules();
3608
3609
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3610
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3611
			$throw = false;
3612
3613
			// Try and make sure it really was the stats plugin
3614
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3615
				if ( 'stats.php' == basename( $plugin ) ) {
3616
					$throw = true;
3617
				}
3618
			} else {
3619
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3620
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3621
					$throw = true;
3622
				}
3623
			}
3624
3625
			if ( $throw ) {
3626
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3627
			}
3628
		}
3629
	}
3630
3631
	function intercept_plugin_error_scrape_init() {
3632
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3633
	}
3634
3635
	function intercept_plugin_error_scrape( $action, $result ) {
3636
		if ( ! $result ) {
3637
			return;
3638
		}
3639
3640
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3641
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3642
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3643
			}
3644
		}
3645
	}
3646
3647
	/**
3648
	 * Register the remote file upload request handlers, if needed.
3649
	 *
3650
	 * @access public
3651
	 */
3652
	public function add_remote_request_handlers() {
3653
		// Remote file uploads are allowed only via AJAX requests.
3654
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3655
			return;
3656
		}
3657
3658
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3659
		$remote_request_actions = array(
3660
			'jetpack_upload_file',
3661
			'jetpack_update_file',
3662
		);
3663
3664
		// phpcs:ignore WordPress.Security.NonceVerification
3665
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3666
			return;
3667
		}
3668
3669
		// Require Jetpack authentication for the remote file upload AJAX requests.
3670
		$this->connection_manager->require_jetpack_authentication();
3671
3672
		// Register the remote file upload AJAX handlers.
3673
		foreach ( $remote_request_actions as $action ) {
3674
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3675
		}
3676
	}
3677
3678
	/**
3679
	 * Handler for Jetpack remote file uploads.
3680
	 *
3681
	 * @access public
3682
	 */
3683
	public function remote_request_handlers() {
3684
		$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...
3685
3686
		switch ( current_filter() ) {
3687
			case 'wp_ajax_nopriv_jetpack_upload_file':
3688
				$response = $this->upload_handler();
3689
				break;
3690
3691
			case 'wp_ajax_nopriv_jetpack_update_file':
3692
				$response = $this->upload_handler( true );
3693
				break;
3694
			default:
3695
				$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...
3696
				break;
3697
		}
3698
3699
		if ( ! $response ) {
3700
			$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...
3701
		}
3702
3703
		if ( is_wp_error( $response ) ) {
3704
			$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...
3705
			$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...
3706
			$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...
3707
3708
			if ( ! is_int( $status_code ) ) {
3709
				$status_code = 400;
3710
			}
3711
3712
			status_header( $status_code );
3713
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3714
		}
3715
3716
		status_header( 200 );
3717
		if ( true === $response ) {
3718
			exit;
3719
		}
3720
3721
		die( json_encode( (object) $response ) );
3722
	}
3723
3724
	/**
3725
	 * Uploads a file gotten from the global $_FILES.
3726
	 * If `$update_media_item` is true and `post_id` is defined
3727
	 * the attachment file of the media item (gotten through of the post_id)
3728
	 * will be updated instead of add a new one.
3729
	 *
3730
	 * @param  boolean $update_media_item - update media attachment
3731
	 * @return array - An array describing the uploadind files process
3732
	 */
3733
	function upload_handler( $update_media_item = false ) {
3734
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3735
			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...
3736
		}
3737
3738
		$user = wp_authenticate( '', '' );
3739
		if ( ! $user || is_wp_error( $user ) ) {
3740
			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...
3741
		}
3742
3743
		wp_set_current_user( $user->ID );
3744
3745
		if ( ! current_user_can( 'upload_files' ) ) {
3746
			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...
3747
		}
3748
3749
		if ( empty( $_FILES ) ) {
3750
			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...
3751
		}
3752
3753
		foreach ( array_keys( $_FILES ) as $files_key ) {
3754
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3755
				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...
3756
			}
3757
		}
3758
3759
		$media_keys = array_keys( $_FILES['media'] );
3760
3761
		$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...
3762
		if ( ! $token || is_wp_error( $token ) ) {
3763
			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...
3764
		}
3765
3766
		$uploaded_files = array();
3767
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3768
		unset( $GLOBALS['post'] );
3769
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3770
			$file = array();
3771
			foreach ( $media_keys as $media_key ) {
3772
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3773
			}
3774
3775
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3776
3777
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3778
			if ( $hmac_provided !== $hmac_file ) {
3779
				$uploaded_files[ $index ] = (object) array(
3780
					'error'             => 'invalid_hmac',
3781
					'error_description' => 'The corresponding HMAC for this file does not match',
3782
				);
3783
				continue;
3784
			}
3785
3786
			$_FILES['.jetpack.upload.'] = $file;
3787
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3788
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3789
				$post_id = 0;
3790
			}
3791
3792
			if ( $update_media_item ) {
3793
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3794
					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...
3795
				}
3796
3797
				$media_array = $_FILES['media'];
3798
3799
				$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...
3800
				$file_array['type']     = $media_array['type'][0];
3801
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3802
				$file_array['error']    = $media_array['error'][0];
3803
				$file_array['size']     = $media_array['size'][0];
3804
3805
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3806
3807
				if ( is_wp_error( $edited_media_item ) ) {
3808
					return $edited_media_item;
3809
				}
3810
3811
				$response = (object) array(
3812
					'id'   => (string) $post_id,
3813
					'file' => (string) $edited_media_item->post_title,
3814
					'url'  => (string) wp_get_attachment_url( $post_id ),
3815
					'type' => (string) $edited_media_item->post_mime_type,
3816
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3817
				);
3818
3819
				return (array) array( $response );
3820
			}
3821
3822
			$attachment_id = media_handle_upload(
3823
				'.jetpack.upload.',
3824
				$post_id,
3825
				array(),
3826
				array(
3827
					'action' => 'jetpack_upload_file',
3828
				)
3829
			);
3830
3831
			if ( ! $attachment_id ) {
3832
				$uploaded_files[ $index ] = (object) array(
3833
					'error'             => 'unknown',
3834
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3835
				);
3836
			} elseif ( is_wp_error( $attachment_id ) ) {
3837
				$uploaded_files[ $index ] = (object) array(
3838
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3839
					'error_description' => $attachment_id->get_error_message(),
3840
				);
3841
			} else {
3842
				$attachment               = get_post( $attachment_id );
3843
				$uploaded_files[ $index ] = (object) array(
3844
					'id'   => (string) $attachment_id,
3845
					'file' => $attachment->post_title,
3846
					'url'  => wp_get_attachment_url( $attachment_id ),
3847
					'type' => $attachment->post_mime_type,
3848
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3849
				);
3850
				// Zip files uploads are not supported unless they are done for installation purposed
3851
				// lets delete them in case something goes wrong in this whole process
3852
				if ( 'application/zip' === $attachment->post_mime_type ) {
3853
					// Schedule a cleanup for 2 hours from now in case of failed install.
3854
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3855
				}
3856
			}
3857
		}
3858
		if ( ! is_null( $global_post ) ) {
3859
			$GLOBALS['post'] = $global_post;
3860
		}
3861
3862
		return $uploaded_files;
3863
	}
3864
3865
	/**
3866
	 * Add help to the Jetpack page
3867
	 *
3868
	 * @since Jetpack (1.2.3)
3869
	 * @return false if not the Jetpack page
3870
	 */
3871
	function admin_help() {
3872
		$current_screen = get_current_screen();
3873
3874
		// Overview
3875
		$current_screen->add_help_tab(
3876
			array(
3877
				'id'      => 'home',
3878
				'title'   => __( 'Home', 'jetpack' ),
3879
				'content' =>
3880
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3881
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3882
					'<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>',
3883
			)
3884
		);
3885
3886
		// Screen Content
3887
		if ( current_user_can( 'manage_options' ) ) {
3888
			$current_screen->add_help_tab(
3889
				array(
3890
					'id'      => 'settings',
3891
					'title'   => __( 'Settings', 'jetpack' ),
3892
					'content' =>
3893
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3894
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3895
						'<ol>' .
3896
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3897
							'<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>' .
3898
						'</ol>' .
3899
						'<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>',
3900
				)
3901
			);
3902
		}
3903
3904
		// Help Sidebar
3905
		$current_screen->set_help_sidebar(
3906
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3907
			'<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3908
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3909
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3910
		);
3911
	}
3912
3913
	function admin_menu_css() {
3914
		wp_enqueue_style( 'jetpack-icons' );
3915
	}
3916
3917
	function admin_menu_order() {
3918
		return true;
3919
	}
3920
3921 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3922
		$jp_menu_order = array();
3923
3924
		foreach ( $menu_order as $index => $item ) {
3925
			if ( $item != 'jetpack' ) {
3926
				$jp_menu_order[] = $item;
3927
			}
3928
3929
			if ( $index == 0 ) {
3930
				$jp_menu_order[] = 'jetpack';
3931
			}
3932
		}
3933
3934
		return $jp_menu_order;
3935
	}
3936
3937
	function admin_banner_styles() {
3938
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3939
3940
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3941
			wp_register_style(
3942
				'jetpack-dops-style',
3943
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3944
				array(),
3945
				JETPACK__VERSION
3946
			);
3947
		}
3948
3949
		wp_enqueue_style(
3950
			'jetpack',
3951
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3952
			array( 'jetpack-dops-style' ),
3953
			JETPACK__VERSION . '-20121016'
3954
		);
3955
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3956
		wp_style_add_data( 'jetpack', 'suffix', $min );
3957
	}
3958
3959
	function plugin_action_links( $actions ) {
3960
3961
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3962
3963
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || self::is_development_mode() ) ) {
3964
			return array_merge(
3965
				$jetpack_home,
3966
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3967
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3968
				$actions
3969
			);
3970
		}
3971
3972
		return array_merge( $jetpack_home, $actions );
3973
	}
3974
3975
	/*
3976
	 * Registration flow:
3977
	 * 1 - ::admin_page_load() action=register
3978
	 * 2 - ::try_registration()
3979
	 * 3 - ::register()
3980
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3981
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3982
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3983
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3984
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3985
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3986
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3987
	 *       jetpack_id, jetpack_secret, jetpack_public
3988
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3989
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3990
	 * 5 - user logs in with WP.com account
3991
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3992
	 *		- Jetpack_Client_Server::authorize()
3993
	 *		- Jetpack_Client_Server::get_token()
3994
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3995
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3996
	 *			- which responds with access_token, token_type, scope
3997
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3998
	 *		- Jetpack::activate_default_modules()
3999
	 *     		- Deactivates deprecated plugins
4000
	 *     		- Activates all default modules
4001
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4002
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4003
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4004
	 *     Done!
4005
	 */
4006
4007
	/**
4008
	 * Handles the page load events for the Jetpack admin page
4009
	 */
4010
	function admin_page_load() {
4011
		$error = false;
4012
4013
		// Make sure we have the right body class to hook stylings for subpages off of.
4014
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4015
4016
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4017
			// Should only be used in intermediate redirects to preserve state across redirects
4018
			self::restate();
4019
		}
4020
4021
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4022
			// @todo: Add validation against a known whitelist
4023
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4024
			// User clicked in the iframe to link their accounts
4025
			if ( ! self::is_user_connected() ) {
4026
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4027
4028
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4029
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4030
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4031
4032
				if ( isset( $_GET['notes_iframe'] ) ) {
4033
					$connect_url .= '&notes_iframe';
4034
				}
4035
				wp_redirect( $connect_url );
4036
				exit;
4037
			} else {
4038
				if ( ! isset( $_GET['calypso_env'] ) ) {
4039
					self::state( 'message', 'already_authorized' );
4040
					wp_safe_redirect( self::admin_url() );
4041
					exit;
4042
				} else {
4043
					$connect_url  = $this->build_connect_url( true, false, $from );
4044
					$connect_url .= '&already_authorized=true';
4045
					wp_redirect( $connect_url );
4046
					exit;
4047
				}
4048
			}
4049
		}
4050
4051
		if ( isset( $_GET['action'] ) ) {
4052
			switch ( $_GET['action'] ) {
4053
				case 'authorize':
4054
					if ( self::is_active() && self::is_user_connected() ) {
4055
						self::state( 'message', 'already_authorized' );
4056
						wp_safe_redirect( self::admin_url() );
4057
						exit;
4058
					}
4059
					self::log( 'authorize' );
4060
					$client_server = new Jetpack_Client_Server();
4061
					$client_server->client_authorize();
4062
					exit;
4063
				case 'register':
4064
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4065
						$error = 'cheatin';
4066
						break;
4067
					}
4068
					check_admin_referer( 'jetpack-register' );
4069
					self::log( 'register' );
4070
					self::maybe_set_version_option();
4071
					$registered = self::try_registration();
4072 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4073
						$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...
4074
						self::state( 'error', $error );
4075
						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...
4076
4077
						/**
4078
						 * Jetpack registration Error.
4079
						 *
4080
						 * @since 7.5.0
4081
						 *
4082
						 * @param string|int $error The error code.
4083
						 * @param \WP_Error $registered The error object.
4084
						 */
4085
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4086
						break;
4087
					}
4088
4089
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4090
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4091
4092
					/**
4093
					 * Jetpack registration Success.
4094
					 *
4095
					 * @since 7.5.0
4096
					 *
4097
					 * @param string $from 'from' GET parameter;
4098
					 */
4099
					do_action( 'jetpack_connection_register_success', $from );
4100
4101
					$url = $this->build_connect_url( true, $redirect, $from );
4102
4103
					if ( ! empty( $_GET['onboarding'] ) ) {
4104
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4105
					}
4106
4107
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4108
						$url = add_query_arg( 'auth_approved', 'true', $url );
4109
					}
4110
4111
					wp_redirect( $url );
4112
					exit;
4113
				case 'activate':
4114
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4115
						$error = 'cheatin';
4116
						break;
4117
					}
4118
4119
					$module = stripslashes( $_GET['module'] );
4120
					check_admin_referer( "jetpack_activate-$module" );
4121
					self::log( 'activate', $module );
4122
					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...
4123
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4124
					}
4125
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4126
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4127
					exit;
4128
				case 'activate_default_modules':
4129
					check_admin_referer( 'activate_default_modules' );
4130
					self::log( 'activate_default_modules' );
4131
					self::restate();
4132
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4133
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4134
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4135
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4136
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4137
					exit;
4138
				case 'disconnect':
4139
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4140
						$error = 'cheatin';
4141
						break;
4142
					}
4143
4144
					check_admin_referer( 'jetpack-disconnect' );
4145
					self::log( 'disconnect' );
4146
					self::disconnect();
4147
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4148
					exit;
4149
				case 'reconnect':
4150
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4151
						$error = 'cheatin';
4152
						break;
4153
					}
4154
4155
					check_admin_referer( 'jetpack-reconnect' );
4156
					self::log( 'reconnect' );
4157
					$this->disconnect();
4158
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4159
					exit;
4160 View Code Duplication
				case 'deactivate':
4161
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4162
						$error = 'cheatin';
4163
						break;
4164
					}
4165
4166
					$modules = stripslashes( $_GET['module'] );
4167
					check_admin_referer( "jetpack_deactivate-$modules" );
4168
					foreach ( explode( ',', $modules ) as $module ) {
4169
						self::log( 'deactivate', $module );
4170
						self::deactivate_module( $module );
4171
						self::state( 'message', 'module_deactivated' );
4172
					}
4173
					self::state( 'module', $modules );
4174
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4175
					exit;
4176
				case 'unlink':
4177
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4178
					check_admin_referer( 'jetpack-unlink' );
4179
					self::log( 'unlink' );
4180
					Connection_Manager::disconnect_user();
4181
					self::state( 'message', 'unlinked' );
4182
					if ( 'sub-unlink' == $redirect ) {
4183
						wp_safe_redirect( admin_url() );
4184
					} else {
4185
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4186
					}
4187
					exit;
4188
				case 'onboard':
4189
					if ( ! current_user_can( 'manage_options' ) ) {
4190
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4191
					} else {
4192
						self::create_onboarding_token();
4193
						$url = $this->build_connect_url( true );
4194
4195
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4196
							$url = add_query_arg( 'onboarding', $token, $url );
4197
						}
4198
4199
						$calypso_env = $this->get_calypso_env();
4200
						if ( ! empty( $calypso_env ) ) {
4201
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4202
						}
4203
4204
						wp_redirect( $url );
4205
						exit;
4206
					}
4207
					exit;
4208
				default:
4209
					/**
4210
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4211
					 *
4212
					 * @since 2.6.0
4213
					 *
4214
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4215
					 */
4216
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4217
			}
4218
		}
4219
4220
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4221
			self::activate_new_modules( true );
4222
		}
4223
4224
		$message_code = self::state( 'message' );
4225
		if ( self::state( 'optin-manage' ) ) {
4226
			$activated_manage = $message_code;
4227
			$message_code     = 'jetpack-manage';
4228
		}
4229
4230
		switch ( $message_code ) {
4231
			case 'jetpack-manage':
4232
				$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>';
4233
				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...
4234
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4235
				}
4236
				break;
4237
4238
		}
4239
4240
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4241
4242
		if ( ! empty( $deactivated_plugins ) ) {
4243
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4244
			$deactivated_titles  = array();
4245
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4246
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4247
					continue;
4248
				}
4249
4250
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4251
			}
4252
4253
			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...
4254
				if ( $this->message ) {
4255
					$this->message .= "<br /><br />\n";
4256
				}
4257
4258
				$this->message .= wp_sprintf(
4259
					_n(
4260
						'Jetpack contains the most recent version of the old %l plugin.',
4261
						'Jetpack contains the most recent versions of the old %l plugins.',
4262
						count( $deactivated_titles ),
4263
						'jetpack'
4264
					),
4265
					$deactivated_titles
4266
				);
4267
4268
				$this->message .= "<br />\n";
4269
4270
				$this->message .= _n(
4271
					'The old version has been deactivated and can be removed from your site.',
4272
					'The old versions have been deactivated and can be removed from your site.',
4273
					count( $deactivated_titles ),
4274
					'jetpack'
4275
				);
4276
			}
4277
		}
4278
4279
		$this->privacy_checks = self::state( 'privacy_checks' );
4280
4281
		if ( $this->message || $this->error || $this->privacy_checks ) {
4282
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4283
		}
4284
4285
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4286
	}
4287
4288
	function admin_notices() {
4289
4290
		if ( $this->error ) {
4291
			?>
4292
<div id="message" class="jetpack-message jetpack-err">
4293
	<div class="squeezer">
4294
		<h2>
4295
			<?php
4296
			echo wp_kses(
4297
				$this->error,
4298
				array(
4299
					'a'      => array( 'href' => array() ),
4300
					'small'  => true,
4301
					'code'   => true,
4302
					'strong' => true,
4303
					'br'     => true,
4304
					'b'      => true,
4305
				)
4306
			);
4307
			?>
4308
			</h2>
4309
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4310
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4311
<?php	endif; ?>
4312
	</div>
4313
</div>
4314
			<?php
4315
		}
4316
4317
		if ( $this->message ) {
4318
			?>
4319
<div id="message" class="jetpack-message">
4320
	<div class="squeezer">
4321
		<h2>
4322
			<?php
4323
			echo wp_kses(
4324
				$this->message,
4325
				array(
4326
					'strong' => array(),
4327
					'a'      => array( 'href' => true ),
4328
					'br'     => true,
4329
				)
4330
			);
4331
			?>
4332
			</h2>
4333
	</div>
4334
</div>
4335
			<?php
4336
		}
4337
4338
		if ( $this->privacy_checks ) :
4339
			$module_names = $module_slugs = array();
4340
4341
			$privacy_checks = explode( ',', $this->privacy_checks );
4342
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4343
			foreach ( $privacy_checks as $module_slug ) {
4344
				$module = self::get_module( $module_slug );
4345
				if ( ! $module ) {
4346
					continue;
4347
				}
4348
4349
				$module_slugs[] = $module_slug;
4350
				$module_names[] = "<strong>{$module['name']}</strong>";
4351
			}
4352
4353
			$module_slugs = join( ',', $module_slugs );
4354
			?>
4355
<div id="message" class="jetpack-message jetpack-err">
4356
	<div class="squeezer">
4357
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4358
		<p>
4359
			<?php
4360
			echo wp_kses(
4361
				wptexturize(
4362
					wp_sprintf(
4363
						_nx(
4364
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4365
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4366
							count( $privacy_checks ),
4367
							'%l = list of Jetpack module/feature names',
4368
							'jetpack'
4369
						),
4370
						$module_names
4371
					)
4372
				),
4373
				array( 'strong' => true )
4374
			);
4375
4376
			echo "\n<br />\n";
4377
4378
			echo wp_kses(
4379
				sprintf(
4380
					_nx(
4381
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4382
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4383
						count( $privacy_checks ),
4384
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4385
						'jetpack'
4386
					),
4387
					wp_nonce_url(
4388
						self::admin_url(
4389
							array(
4390
								'page'   => 'jetpack',
4391
								'action' => 'deactivate',
4392
								'module' => urlencode( $module_slugs ),
4393
							)
4394
						),
4395
						"jetpack_deactivate-$module_slugs"
4396
					),
4397
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4398
				),
4399
				array(
4400
					'a' => array(
4401
						'href'  => true,
4402
						'title' => true,
4403
					),
4404
				)
4405
			);
4406
			?>
4407
		</p>
4408
	</div>
4409
</div>
4410
			<?php
4411
endif;
4412
	}
4413
4414
	/**
4415
	 * We can't always respond to a signed XML-RPC request with a
4416
	 * helpful error message. In some circumstances, doing so could
4417
	 * leak information.
4418
	 *
4419
	 * Instead, track that the error occurred via a Jetpack_Option,
4420
	 * and send that data back in the heartbeat.
4421
	 * All this does is increment a number, but it's enough to find
4422
	 * trends.
4423
	 *
4424
	 * @param WP_Error $xmlrpc_error The error produced during
4425
	 *                               signature validation.
4426
	 */
4427
	function track_xmlrpc_error( $xmlrpc_error ) {
4428
		$code = is_wp_error( $xmlrpc_error )
4429
			? $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...
4430
			: 'should-not-happen';
4431
4432
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4433
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4434
			// No need to update the option if we already have
4435
			// this code stored.
4436
			return;
4437
		}
4438
		$xmlrpc_errors[ $code ] = true;
4439
4440
		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...
4441
	}
4442
4443
	/**
4444
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4445
	 */
4446
	function stat( $group, $detail ) {
4447
		if ( ! isset( $this->stats[ $group ] ) ) {
4448
			$this->stats[ $group ] = array();
4449
		}
4450
		$this->stats[ $group ][] = $detail;
4451
	}
4452
4453
	/**
4454
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4455
	 */
4456
	function do_stats( $method = '' ) {
4457
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4458
			foreach ( $this->stats as $group => $stats ) {
4459
				if ( is_array( $stats ) && count( $stats ) ) {
4460
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4461
					if ( 'server_side' === $method ) {
4462
						self::do_server_side_stat( $args );
4463
					} else {
4464
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4465
					}
4466
				}
4467
				unset( $this->stats[ $group ] );
4468
			}
4469
		}
4470
	}
4471
4472
	/**
4473
	 * Runs stats code for a one-off, server-side.
4474
	 *
4475
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4476
	 *
4477
	 * @return bool If it worked.
4478
	 */
4479
	static function do_server_side_stat( $args ) {
4480
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4481
		if ( is_wp_error( $response ) ) {
4482
			return false;
4483
		}
4484
4485
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4486
			return false;
4487
		}
4488
4489
		return true;
4490
	}
4491
4492
	/**
4493
	 * Builds the stats url.
4494
	 *
4495
	 * @param $args array|string The arguments to append to the URL.
4496
	 *
4497
	 * @return string The URL to be pinged.
4498
	 */
4499
	static function build_stats_url( $args ) {
4500
		$defaults = array(
4501
			'v'    => 'wpcom2',
4502
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4503
		);
4504
		$args     = wp_parse_args( $args, $defaults );
4505
		/**
4506
		 * Filter the URL used as the Stats tracking pixel.
4507
		 *
4508
		 * @since 2.3.2
4509
		 *
4510
		 * @param string $url Base URL used as the Stats tracking pixel.
4511
		 */
4512
		$base_url = apply_filters(
4513
			'jetpack_stats_base_url',
4514
			'https://pixel.wp.com/g.gif'
4515
		);
4516
		$url      = add_query_arg( $args, $base_url );
4517
		return $url;
4518
	}
4519
4520
	/**
4521
	 * Get the role of the current user.
4522
	 *
4523
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4524
	 *
4525
	 * @access public
4526
	 * @static
4527
	 *
4528
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4529
	 */
4530
	public static function translate_current_user_to_role() {
4531
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4532
4533
		$roles = new Roles();
4534
		return $roles->translate_current_user_to_role();
4535
	}
4536
4537
	/**
4538
	 * Get the role of a particular user.
4539
	 *
4540
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4541
	 *
4542
	 * @access public
4543
	 * @static
4544
	 *
4545
	 * @param \WP_User $user User object.
4546
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4547
	 */
4548
	public static function translate_user_to_role( $user ) {
4549
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4550
4551
		$roles = new Roles();
4552
		return $roles->translate_user_to_role( $user );
4553
	}
4554
4555
	/**
4556
	 * Get the minimum capability for a role.
4557
	 *
4558
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4559
	 *
4560
	 * @access public
4561
	 * @static
4562
	 *
4563
	 * @param string $role Role name.
4564
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4565
	 */
4566
	public static function translate_role_to_cap( $role ) {
4567
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4568
4569
		$roles = new Roles();
4570
		return $roles->translate_role_to_cap( $role );
4571
	}
4572
4573
	/**
4574
	 * Sign a user role with the master access token.
4575
	 * If not specified, will default to the current user.
4576
	 *
4577
	 * @deprecated since 7.7
4578
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4579
	 *
4580
	 * @access public
4581
	 * @static
4582
	 *
4583
	 * @param string $role    User role.
4584
	 * @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...
4585
	 * @return string Signed user role.
4586
	 */
4587
	public static function sign_role( $role, $user_id = null ) {
4588
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4589
		return self::connection()->sign_role( $role, $user_id );
4590
	}
4591
4592
	/**
4593
	 * Builds a URL to the Jetpack connection auth page
4594
	 *
4595
	 * @since 3.9.5
4596
	 *
4597
	 * @param bool        $raw If true, URL will not be escaped.
4598
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4599
	 *                              If string, will be a custom redirect.
4600
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4601
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4602
	 *
4603
	 * @return string Connect URL
4604
	 */
4605
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4606
		$site_id    = Jetpack_Options::get_option( 'id' );
4607
		$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...
4608
4609
		if ( $register || ! $blog_token || ! $site_id ) {
4610
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4611
4612
			if ( ! empty( $redirect ) ) {
4613
				$url = add_query_arg(
4614
					'redirect',
4615
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4616
					$url
4617
				);
4618
			}
4619
4620
			if ( is_network_admin() ) {
4621
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4622
			}
4623
4624
			$calypso_env = self::get_calypso_env();
4625
4626
			if ( ! empty( $calypso_env ) ) {
4627
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4628
			}
4629
		} else {
4630
4631
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4632
			// because otherwise this logic can get us in to a loop.
4633
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4634
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4635
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4636
4637
				$response = Client::wpcom_json_api_request_as_blog(
4638
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4639
					'1.1'
4640
				);
4641
4642
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4643
4644
					// Generating a register URL instead to refresh the existing token
4645
					return $this->build_connect_url( $raw, $redirect, $from, true );
4646
				}
4647
			}
4648
4649
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4605 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...
4650
		}
4651
4652
		if ( $from ) {
4653
			$url = add_query_arg( 'from', $from, $url );
4654
		}
4655
4656
		// Ensure that class to get the affiliate code is loaded
4657
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
4658
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
4659
		}
4660
		// Get affiliate code and add it to the URL
4661
		$url = Jetpack_Affiliate::init()->add_code_as_query_arg( $url );
4662
4663
		return $raw ? esc_url_raw( $url ) : esc_url( $url );
4664
	}
4665
4666
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4667
		if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4668
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4669
		}
4670
4671
		$roles       = new Roles();
4672
		$role        = $roles->translate_current_user_to_role();
4673
		$signed_role = self::connection()->sign_role( $role );
4674
4675
		$user = wp_get_current_user();
4676
4677
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4678
		$redirect           = $redirect
4679
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4680
			: $jetpack_admin_page;
4681
4682
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4683
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4684
		}
4685
4686
		$secrets = self::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4687
4688
		/**
4689
		 * Filter the type of authorization.
4690
		 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4691
		 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4692
		 *
4693
		 * @since 4.3.3
4694
		 *
4695
		 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4696
		 */
4697
		$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4698
4699
		$tracks          = new Tracking();
4700
		$tracks_identity = $tracks->tracks_get_identity( get_current_user_id() );
4701
4702
		$args = urlencode_deep(
4703
			array(
4704
				'response_type' => 'code',
4705
				'client_id'     => Jetpack_Options::get_option( 'id' ),
4706
				'redirect_uri'  => add_query_arg(
4707
					array(
4708
						'action'   => 'authorize',
4709
						'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4710
						'redirect' => urlencode( $redirect ),
4711
					),
4712
					esc_url( admin_url( 'admin.php?page=jetpack' ) )
4713
				),
4714
				'state'         => $user->ID,
4715
				'scope'         => $signed_role,
4716
				'user_email'    => $user->user_email,
4717
				'user_login'    => $user->user_login,
4718
				'is_active'     => self::is_active(),
4719
				'jp_version'    => JETPACK__VERSION,
4720
				'auth_type'     => $auth_type,
4721
				'secret'        => $secrets['secret_1'],
4722
				'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4723
				'blogname'      => get_option( 'blogname' ),
4724
				'site_url'      => site_url(),
4725
				'home_url'      => home_url(),
4726
				'site_icon'     => get_site_icon_url(),
4727
				'site_lang'     => get_locale(),
4728
				'_ui'           => $tracks_identity['_ui'],
4729
				'_ut'           => $tracks_identity['_ut'],
4730
				'site_created'  => self::connection()->get_assumed_site_creation_date(),
4731
			)
4732
		);
4733
4734
		self::apply_activation_source_to_args( $args );
4735
4736
		$connection = self::connection();
4737
4738
		$calypso_env = self::get_calypso_env();
4739
4740
		if ( ! empty( $calypso_env ) ) {
4741
			$args['calypso_env'] = $calypso_env;
4742
		}
4743
4744
		$api_url = $iframe ? $connection->api_url( 'authorize_iframe' ) : $connection->api_url( 'authorize' );
4745
4746
		return add_query_arg( $args, $api_url );
4747
	}
4748
4749
	/**
4750
	 * Get our assumed site creation date.
4751
	 * Calculated based on the earlier date of either:
4752
	 * - Earliest admin user registration date.
4753
	 * - Earliest date of post of any post type.
4754
	 *
4755
	 * @since 7.2.0
4756
	 * @deprecated since 7.8.0
4757
	 *
4758
	 * @return string Assumed site creation date and time.
4759
	 */
4760
	public static function get_assumed_site_creation_date() {
4761
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4762
		return self::connection()->get_assumed_site_creation_date();
4763
	}
4764
4765 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4766
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4767
4768
		if ( $activation_source_name ) {
4769
			$args['_as'] = urlencode( $activation_source_name );
4770
		}
4771
4772
		if ( $activation_source_keyword ) {
4773
			$args['_ak'] = urlencode( $activation_source_keyword );
4774
		}
4775
	}
4776
4777
	function build_reconnect_url( $raw = false ) {
4778
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4779
		return $raw ? $url : esc_url( $url );
4780
	}
4781
4782
	public static function admin_url( $args = null ) {
4783
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4784
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4785
		return $url;
4786
	}
4787
4788
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4789
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4790
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4791
	}
4792
4793
	function dismiss_jetpack_notice() {
4794
4795
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4796
			return;
4797
		}
4798
4799
		switch ( $_GET['jetpack-notice'] ) {
4800
			case 'dismiss':
4801
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4802
4803
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4804
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4805
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4806
				}
4807
				break;
4808
		}
4809
	}
4810
4811
	public static function sort_modules( $a, $b ) {
4812
		if ( $a['sort'] == $b['sort'] ) {
4813
			return 0;
4814
		}
4815
4816
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4817
	}
4818
4819
	function ajax_recheck_ssl() {
4820
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4821
		$result = self::permit_ssl( true );
4822
		wp_send_json(
4823
			array(
4824
				'enabled' => $result,
4825
				'message' => get_transient( 'jetpack_https_test_message' ),
4826
			)
4827
		);
4828
	}
4829
4830
	/* Client API */
4831
4832
	/**
4833
	 * Returns the requested Jetpack API URL
4834
	 *
4835
	 * @deprecated since 7.7
4836
	 * @return string
4837
	 */
4838
	public static function api_url( $relative_url ) {
4839
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
4840
		$connection = self::connection();
4841
		return $connection->api_url( $relative_url );
4842
	}
4843
4844
	/**
4845
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4846
	 */
4847
	public static function fix_url_for_bad_hosts( $url ) {
4848
		if ( 0 !== strpos( $url, 'https://' ) ) {
4849
			return $url;
4850
		}
4851
4852
		switch ( JETPACK_CLIENT__HTTPS ) {
4853
			case 'ALWAYS':
4854
				return $url;
4855
			case 'NEVER':
4856
				return set_url_scheme( $url, 'http' );
4857
			// default : case 'AUTO' :
4858
		}
4859
4860
		// we now return the unmodified SSL URL by default, as a security precaution
4861
		return $url;
4862
	}
4863
4864
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
4865
		// Default to a blog token.
4866
		$token_type = 'blog';
4867
4868
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
4869
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
4870
			if ( ! empty( $_GET['onboarding'] ) ) {
4871
				$jpo = $_GET;
4872
			} else {
4873
				$jpo = json_decode( $request_data, true );
4874
			}
4875
4876
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
4877
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
4878
4879
			if (
4880
				isset( $jpo_user )
4881
				&& isset( $jpo_token )
4882
				&& is_email( $jpo_user )
4883
				&& ctype_alnum( $jpo_token )
4884
				&& isset( $_GET['rest_route'] )
4885
				&& self::validate_onboarding_token_action(
4886
					$jpo_token,
4887
					$_GET['rest_route']
4888
				)
4889
			) {
4890
				$jp_user = get_user_by( 'email', $jpo_user );
4891
				if ( is_a( $jp_user, 'WP_User' ) ) {
4892
					wp_set_current_user( $jp_user->ID );
4893
					$user_can = is_multisite()
4894
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
4895
						: current_user_can( 'manage_options' );
4896
					if ( $user_can ) {
4897
						$token_type              = 'user';
4898
						$token->external_user_id = $jp_user->ID;
4899
					}
4900
				}
4901
			}
4902
4903
			$token_data['type']    = $token_type;
4904
			$token_data['user_id'] = $token->external_user_id;
4905
		}
4906
4907
		return $token_data;
4908
	}
4909
4910
	/**
4911
	 * Create a random secret for validating onboarding payload
4912
	 *
4913
	 * @return string Secret token
4914
	 */
4915
	public static function create_onboarding_token() {
4916
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4917
			$token = wp_generate_password( 32, false );
4918
			Jetpack_Options::update_option( 'onboarding', $token );
4919
		}
4920
4921
		return $token;
4922
	}
4923
4924
	/**
4925
	 * Remove the onboarding token
4926
	 *
4927
	 * @return bool True on success, false on failure
4928
	 */
4929
	public static function invalidate_onboarding_token() {
4930
		return Jetpack_Options::delete_option( 'onboarding' );
4931
	}
4932
4933
	/**
4934
	 * Validate an onboarding token for a specific action
4935
	 *
4936
	 * @return boolean True if token/action pair is accepted, false if not
4937
	 */
4938
	public static function validate_onboarding_token_action( $token, $action ) {
4939
		// Compare tokens, bail if tokens do not match
4940
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4941
			return false;
4942
		}
4943
4944
		// List of valid actions we can take
4945
		$valid_actions = array(
4946
			'/jetpack/v4/settings',
4947
		);
4948
4949
		// Whitelist the action
4950
		if ( ! in_array( $action, $valid_actions ) ) {
4951
			return false;
4952
		}
4953
4954
		return true;
4955
	}
4956
4957
	/**
4958
	 * Checks to see if the URL is using SSL to connect with Jetpack
4959
	 *
4960
	 * @since 2.3.3
4961
	 * @return boolean
4962
	 */
4963
	public static function permit_ssl( $force_recheck = false ) {
4964
		// Do some fancy tests to see if ssl is being supported
4965
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4966
			$message = '';
4967
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4968
				$ssl = 0;
4969
			} else {
4970
				switch ( JETPACK_CLIENT__HTTPS ) {
4971
					case 'NEVER':
4972
						$ssl     = 0;
4973
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4974
						break;
4975
					case 'ALWAYS':
4976
					case 'AUTO':
4977
					default:
4978
						$ssl = 1;
4979
						break;
4980
				}
4981
4982
				// If it's not 'NEVER', test to see
4983
				if ( $ssl ) {
4984
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4985
						$ssl     = 0;
4986
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4987
					} else {
4988
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4989
						if ( is_wp_error( $response ) ) {
4990
							$ssl     = 0;
4991
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4992
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4993
							$ssl     = 0;
4994
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4995
						}
4996
					}
4997
				}
4998
			}
4999
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5000
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5001
		}
5002
5003
		return (bool) $ssl;
5004
	}
5005
5006
	/*
5007
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5008
	 */
5009
	public function alert_auto_ssl_fail() {
5010
		if ( ! current_user_can( 'manage_options' ) ) {
5011
			return;
5012
		}
5013
5014
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5015
		?>
5016
5017
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5018
			<div class="jp-banner__content">
5019
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5020
				<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>
5021
				<p>
5022
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5023
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5024
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5025
				</p>
5026
				<p>
5027
					<?php
5028
					printf(
5029
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5030
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5031
						esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' )
5032
					);
5033
					?>
5034
				</p>
5035
			</div>
5036
		</div>
5037
		<style>
5038
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5039
		</style>
5040
		<script type="text/javascript">
5041
			jQuery( document ).ready( function( $ ) {
5042
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5043
					var $this = $( this );
5044
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5045
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5046
					e.preventDefault();
5047
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5048
					$.post( ajaxurl, data )
5049
					  .done( function( response ) {
5050
						  if ( response.enabled ) {
5051
							  $( '#jetpack-ssl-warning' ).hide();
5052
						  } else {
5053
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5054
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5055
						  }
5056
					  }.bind( $this ) );
5057
				} );
5058
			} );
5059
		</script>
5060
5061
		<?php
5062
	}
5063
5064
	/**
5065
	 * Returns the Jetpack XML-RPC API
5066
	 *
5067
	 * @return string
5068
	 */
5069
	public static function xmlrpc_api_url() {
5070
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
5071
		return untrailingslashit( $base ) . '/xmlrpc.php';
5072
	}
5073
5074
	public static function connection() {
5075
		return self::init()->connection_manager;
5076
	}
5077
5078
	/**
5079
	 * Creates two secret tokens and the end of life timestamp for them.
5080
	 *
5081
	 * Note these tokens are unique per call, NOT static per site for connecting.
5082
	 *
5083
	 * @since 2.6
5084
	 * @return array
5085
	 */
5086
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5087
		if ( false === $user_id ) {
5088
			$user_id = get_current_user_id();
5089
		}
5090
5091
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5092
	}
5093
5094
	public static function get_secrets( $action, $user_id ) {
5095
		$secrets = self::connection()->get_secrets( $action, $user_id );
5096
5097
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5098
			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...
5099
		}
5100
5101
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5102
			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...
5103
		}
5104
5105
		return $secrets;
5106
	}
5107
5108
	/**
5109
	 * @deprecated 7.5 Use Connection_Manager instead.
5110
	 *
5111
	 * @param $action
5112
	 * @param $user_id
5113
	 */
5114
	public static function delete_secrets( $action, $user_id ) {
5115
		return self::connection()->delete_secrets( $action, $user_id );
5116
	}
5117
5118
	/**
5119
	 * Builds the timeout limit for queries talking with the wpcom servers.
5120
	 *
5121
	 * Based on local php max_execution_time in php.ini
5122
	 *
5123
	 * @since 2.6
5124
	 * @return int
5125
	 * @deprecated
5126
	 **/
5127
	public function get_remote_query_timeout_limit() {
5128
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5129
		return self::get_max_execution_time();
5130
	}
5131
5132
	/**
5133
	 * Builds the timeout limit for queries talking with the wpcom servers.
5134
	 *
5135
	 * Based on local php max_execution_time in php.ini
5136
	 *
5137
	 * @since 5.4
5138
	 * @return int
5139
	 **/
5140
	public static function get_max_execution_time() {
5141
		$timeout = (int) ini_get( 'max_execution_time' );
5142
5143
		// Ensure exec time set in php.ini
5144
		if ( ! $timeout ) {
5145
			$timeout = 30;
5146
		}
5147
		return $timeout;
5148
	}
5149
5150
	/**
5151
	 * Sets a minimum request timeout, and returns the current timeout
5152
	 *
5153
	 * @since 5.4
5154
	 **/
5155 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5156
		$timeout = self::get_max_execution_time();
5157
		if ( $timeout < $min_timeout ) {
5158
			$timeout = $min_timeout;
5159
			set_time_limit( $timeout );
5160
		}
5161
		return $timeout;
5162
	}
5163
5164
	/**
5165
	 * Takes the response from the Jetpack register new site endpoint and
5166
	 * verifies it worked properly.
5167
	 *
5168
	 * @since 2.6
5169
	 * @deprecated since 7.7.0
5170
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5171
	 **/
5172
	public function validate_remote_register_response() {
5173
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5174
	}
5175
5176
	/**
5177
	 * @return bool|WP_Error
5178
	 */
5179
	public static function register() {
5180
		$tracking = new Tracking();
5181
		$tracking->record_user_event( 'jpc_register_begin' );
5182
5183
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5184
5185
		$connection   = self::connection();
5186
		$registration = $connection->register();
5187
5188
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5189
5190
		if ( ! $registration || is_wp_error( $registration ) ) {
5191
			return $registration;
5192
		}
5193
5194
		return true;
5195
	}
5196
5197
	/**
5198
	 * Filters the registration request body to include tracking properties.
5199
	 *
5200
	 * @param Array $properties
5201
	 * @return Array amended properties.
5202
	 */
5203
	public static function filter_register_request_body( $properties ) {
5204
		$tracking        = new Tracking();
5205
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5206
5207
		return array_merge(
5208
			$properties,
5209
			array(
5210
				'_ui' => $tracks_identity['_ui'],
5211
				'_ut' => $tracks_identity['_ut'],
5212
			)
5213
		);
5214
	}
5215
5216
	/**
5217
	 * If the db version is showing something other that what we've got now, bump it to current.
5218
	 *
5219
	 * @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...
5220
	 */
5221
	public static function maybe_set_version_option() {
5222
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5223
		if ( JETPACK__VERSION != $version ) {
5224
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5225
5226
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5227
				/** This action is documented in class.jetpack.php */
5228
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5229
			}
5230
5231
			return true;
5232
		}
5233
		return false;
5234
	}
5235
5236
	/* Client Server API */
5237
5238
	/**
5239
	 * Loads the Jetpack XML-RPC client.
5240
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5241
	 *
5242
	 * @deprecated since 7.7.0
5243
	 */
5244
	public static function load_xml_rpc_client() {
5245
		// Removed the php notice that shows up in order to give time to Akismet and VaultPress time to update.
5246
		// _deprecated_function( __METHOD__, 'jetpack-7.7' );
5247
	}
5248
5249
	/**
5250
	 * Resets the saved authentication state in between testing requests.
5251
	 */
5252
	public function reset_saved_auth_state() {
5253
		$this->rest_authentication_status = null;
5254
		$this->connection_manager->reset_saved_auth_state();
5255
	}
5256
5257
	/**
5258
	 * Verifies the signature of the current request.
5259
	 *
5260
	 * @deprecated since 7.7.0
5261
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5262
	 *
5263
	 * @return false|array
5264
	 */
5265
	public function verify_xml_rpc_signature() {
5266
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5267
		return self::connection()->verify_xml_rpc_signature();
5268
	}
5269
5270
	/**
5271
	 * Verifies the signature of the current request.
5272
	 *
5273
	 * This function has side effects and should not be used. Instead,
5274
	 * use the memoized version `->verify_xml_rpc_signature()`.
5275
	 *
5276
	 * @deprecated since 7.7.0
5277
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5278
	 * @internal
5279
	 */
5280
	private function internal_verify_xml_rpc_signature() {
5281
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5282
	}
5283
5284
	/**
5285
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5286
	 *
5287
	 * @deprecated since 7.7.0
5288
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5289
	 *
5290
	 * @param \WP_User|mixed $user     User object if authenticated.
5291
	 * @param string         $username Username.
5292
	 * @param string         $password Password string.
5293
	 * @return \WP_User|mixed Authenticated user or error.
5294
	 */
5295
	public function authenticate_jetpack( $user, $username, $password ) {
5296
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5297
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5298
	}
5299
5300
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5301
	// Uses the existing XMLRPC request signing implementation.
5302
	function wp_rest_authenticate( $user ) {
5303
		if ( ! empty( $user ) ) {
5304
			// Another authentication method is in effect.
5305
			return $user;
5306
		}
5307
5308
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5309
			// Nothing to do for this authentication method.
5310
			return null;
5311
		}
5312
5313
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5314
			// Nothing to do for this authentication method.
5315
			return null;
5316
		}
5317
5318
		// Ensure that we always have the request body available.  At this
5319
		// point, the WP REST API code to determine the request body has not
5320
		// run yet.  That code may try to read from 'php://input' later, but
5321
		// this can only be done once per request in PHP versions prior to 5.6.
5322
		// So we will go ahead and perform this read now if needed, and save
5323
		// the request body where both the Jetpack signature verification code
5324
		// and the WP REST API code can see it.
5325
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5326
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5327
		}
5328
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5329
5330
		// Only support specific request parameters that have been tested and
5331
		// are known to work with signature verification.  A different method
5332
		// can be passed to the WP REST API via the '?_method=' parameter if
5333
		// needed.
5334
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5335
			$this->rest_authentication_status = new WP_Error(
5336
				'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...
5337
				__( 'This request method is not supported.', 'jetpack' ),
5338
				array( 'status' => 400 )
5339
			);
5340
			return null;
5341
		}
5342
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5343
			$this->rest_authentication_status = new WP_Error(
5344
				'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...
5345
				__( 'This request method does not support body parameters.', 'jetpack' ),
5346
				array( 'status' => 400 )
5347
			);
5348
			return null;
5349
		}
5350
5351
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5352
5353
		if (
5354
			$verified &&
5355
			isset( $verified['type'] ) &&
5356
			'user' === $verified['type'] &&
5357
			! empty( $verified['user_id'] )
5358
		) {
5359
			// Authentication successful.
5360
			$this->rest_authentication_status = true;
5361
			return $verified['user_id'];
5362
		}
5363
5364
		// Something else went wrong.  Probably a signature error.
5365
		$this->rest_authentication_status = new WP_Error(
5366
			'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...
5367
			__( 'The request is not signed correctly.', 'jetpack' ),
5368
			array( 'status' => 400 )
5369
		);
5370
		return null;
5371
	}
5372
5373
	/**
5374
	 * Report authentication status to the WP REST API.
5375
	 *
5376
	 * @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...
5377
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5378
	 */
5379
	public function wp_rest_authentication_errors( $value ) {
5380
		if ( $value !== null ) {
5381
			return $value;
5382
		}
5383
		return $this->rest_authentication_status;
5384
	}
5385
5386
	/**
5387
	 * Add our nonce to this request.
5388
	 *
5389
	 * @deprecated since 7.7.0
5390
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5391
	 *
5392
	 * @param int    $timestamp Timestamp of the request.
5393
	 * @param string $nonce     Nonce string.
5394
	 */
5395
	public function add_nonce( $timestamp, $nonce ) {
5396
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5397
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5398
	}
5399
5400
	/**
5401
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5402
	 * Capture it here so we can verify the signature later.
5403
	 *
5404
	 * @deprecated since 7.7.0
5405
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5406
	 *
5407
	 * @param array $methods XMLRPC methods.
5408
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5409
	 */
5410
	public function xmlrpc_methods( $methods ) {
5411
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5412
		return $this->connection_manager->xmlrpc_methods( $methods );
5413
	}
5414
5415
	/**
5416
	 * Register additional public XMLRPC methods.
5417
	 *
5418
	 * @deprecated since 7.7.0
5419
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5420
	 *
5421
	 * @param array $methods Public XMLRPC methods.
5422
	 * @return array Public XMLRPC methods, with the getOptions one.
5423
	 */
5424
	public function public_xmlrpc_methods( $methods ) {
5425
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5426
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5427
	}
5428
5429
	/**
5430
	 * Handles a getOptions XMLRPC method call.
5431
	 *
5432
	 * @deprecated since 7.7.0
5433
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5434
	 *
5435
	 * @param array $args method call arguments.
5436
	 * @return array an amended XMLRPC server options array.
5437
	 */
5438
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5439
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5440
		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...
5441
	}
5442
5443
	/**
5444
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5445
	 *
5446
	 * @deprecated since 7.7.0
5447
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5448
	 *
5449
	 * @param array $options Standard Core options.
5450
	 * @return array Amended options.
5451
	 */
5452
	public function xmlrpc_options( $options ) {
5453
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5454
		return $this->connection_manager->xmlrpc_options( $options );
5455
	}
5456
5457
	/**
5458
	 * Cleans nonces that were saved when calling ::add_nonce.
5459
	 *
5460
	 * @deprecated since 7.7.0
5461
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5462
	 *
5463
	 * @param bool $all whether to clean even non-expired nonces.
5464
	 */
5465
	public static function clean_nonces( $all = false ) {
5466
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5467
		return self::connection()->clean_nonces( $all );
5468
	}
5469
5470
	/**
5471
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5472
	 * SET: state( $key, $value );
5473
	 * GET: $value = state( $key );
5474
	 *
5475
	 * @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...
5476
	 * @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...
5477
	 * @param bool   $restate private
5478
	 */
5479
	public static function state( $key = null, $value = null, $restate = false ) {
5480
		static $state = array();
5481
		static $path, $domain;
5482
		if ( ! isset( $path ) ) {
5483
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5484
			$admin_url = self::admin_url();
5485
			$bits      = wp_parse_url( $admin_url );
5486
5487
			if ( is_array( $bits ) ) {
5488
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5489
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5490
			} else {
5491
				$path = $domain = null;
5492
			}
5493
		}
5494
5495
		// Extract state from cookies and delete cookies
5496
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5497
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5498
			unset( $_COOKIE['jetpackState'] );
5499
			foreach ( $yum as $k => $v ) {
5500
				if ( strlen( $v ) ) {
5501
					$state[ $k ] = $v;
5502
				}
5503
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5504
			}
5505
		}
5506
5507
		if ( $restate ) {
5508
			foreach ( $state as $k => $v ) {
5509
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5510
			}
5511
			return;
5512
		}
5513
5514
		// Get a state variable
5515
		if ( isset( $key ) && ! isset( $value ) ) {
5516
			if ( array_key_exists( $key, $state ) ) {
5517
				return $state[ $key ];
5518
			}
5519
			return null;
5520
		}
5521
5522
		// Set a state variable
5523
		if ( isset( $key ) && isset( $value ) ) {
5524
			if ( is_array( $value ) && isset( $value[0] ) ) {
5525
				$value = $value[0];
5526
			}
5527
			$state[ $key ] = $value;
5528
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5529
		}
5530
	}
5531
5532
	public static function restate() {
5533
		self::state( null, null, true );
5534
	}
5535
5536
	public static function check_privacy( $file ) {
5537
		static $is_site_publicly_accessible = null;
5538
5539
		if ( is_null( $is_site_publicly_accessible ) ) {
5540
			$is_site_publicly_accessible = false;
5541
5542
			$rpc = new Jetpack_IXR_Client();
5543
5544
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5545
			if ( $success ) {
5546
				$response = $rpc->getResponse();
5547
				if ( $response ) {
5548
					$is_site_publicly_accessible = true;
5549
				}
5550
			}
5551
5552
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5553
		}
5554
5555
		if ( $is_site_publicly_accessible ) {
5556
			return;
5557
		}
5558
5559
		$module_slug = self::get_module_slug( $file );
5560
5561
		$privacy_checks = self::state( 'privacy_checks' );
5562
		if ( ! $privacy_checks ) {
5563
			$privacy_checks = $module_slug;
5564
		} else {
5565
			$privacy_checks .= ",$module_slug";
5566
		}
5567
5568
		self::state( 'privacy_checks', $privacy_checks );
5569
	}
5570
5571
	/**
5572
	 * Helper method for multicall XMLRPC.
5573
	 */
5574
	public static function xmlrpc_async_call() {
5575
		global $blog_id;
5576
		static $clients = array();
5577
5578
		$client_blog_id = is_multisite() ? $blog_id : 0;
5579
5580
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5581
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5582
			if ( function_exists( 'ignore_user_abort' ) ) {
5583
				ignore_user_abort( true );
5584
			}
5585
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5586
		}
5587
5588
		$args = func_get_args();
5589
5590
		if ( ! empty( $args[0] ) ) {
5591
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5592
		} elseif ( is_multisite() ) {
5593
			foreach ( $clients as $client_blog_id => $client ) {
5594
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5595
					continue;
5596
				}
5597
5598
				$switch_success = switch_to_blog( $client_blog_id, true );
5599
				if ( ! $switch_success ) {
5600
					continue;
5601
				}
5602
5603
				flush();
5604
				$client->query();
5605
5606
				restore_current_blog();
5607
			}
5608
		} else {
5609
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5610
				flush();
5611
				$clients[0]->query();
5612
			}
5613
		}
5614
	}
5615
5616
	public static function staticize_subdomain( $url ) {
5617
5618
		// Extract hostname from URL
5619
		$host = parse_url( $url, PHP_URL_HOST );
5620
5621
		// Explode hostname on '.'
5622
		$exploded_host = explode( '.', $host );
5623
5624
		// Retrieve the name and TLD
5625
		if ( count( $exploded_host ) > 1 ) {
5626
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5627
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5628
			// Rebuild domain excluding subdomains
5629
			$domain = $name . '.' . $tld;
5630
		} else {
5631
			$domain = $host;
5632
		}
5633
		// Array of Automattic domains
5634
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5635
5636
		// Return $url if not an Automattic domain
5637
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5638
			return $url;
5639
		}
5640
5641
		if ( is_ssl() ) {
5642
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5643
		}
5644
5645
		srand( crc32( basename( $url ) ) );
5646
		$static_counter = rand( 0, 2 );
5647
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5648
5649
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5650
	}
5651
5652
	/* JSON API Authorization */
5653
5654
	/**
5655
	 * Handles the login action for Authorizing the JSON API
5656
	 */
5657
	function login_form_json_api_authorization() {
5658
		$this->verify_json_api_authorization_request();
5659
5660
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5661
5662
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5663
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5664
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5665
	}
5666
5667
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5668
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5669
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5670
			return $url;
5671
		}
5672
5673
		$parsed_url = parse_url( $url );
5674
		$url        = strtok( $url, '?' );
5675
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5676
		if ( ! empty( $parsed_url['query'] ) ) {
5677
			$url .= "&{$parsed_url['query']}";
5678
		}
5679
5680
		return $url;
5681
	}
5682
5683
	// Make sure the POSTed request is handled by the same action
5684
	function preserve_action_in_login_form_for_json_api_authorization() {
5685
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5686
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5687
	}
5688
5689
	// If someone logs in to approve API access, store the Access Code in usermeta
5690
	function store_json_api_authorization_token( $user_login, $user ) {
5691
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5692
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5693
		$token = wp_generate_password( 32, false );
5694
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5695
	}
5696
5697
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5698
	function allow_wpcom_public_api_domain( $domains ) {
5699
		$domains[] = 'public-api.wordpress.com';
5700
		return $domains;
5701
	}
5702
5703
	static function is_redirect_encoded( $redirect_url ) {
5704
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5705
	}
5706
5707
	// Add all wordpress.com environments to the safe redirect whitelist
5708
	function allow_wpcom_environments( $domains ) {
5709
		$domains[] = 'wordpress.com';
5710
		$domains[] = 'wpcalypso.wordpress.com';
5711
		$domains[] = 'horizon.wordpress.com';
5712
		$domains[] = 'calypso.localhost';
5713
		return $domains;
5714
	}
5715
5716
	// Add the Access Code details to the public-api.wordpress.com redirect
5717
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5718
		return add_query_arg(
5719
			urlencode_deep(
5720
				array(
5721
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5722
					'jetpack-user-id' => (int) $user->ID,
5723
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5724
				)
5725
			),
5726
			$redirect_to
5727
		);
5728
	}
5729
5730
5731
	/**
5732
	 * Verifies the request by checking the signature
5733
	 *
5734
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5735
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5736
	 *
5737
	 * @param null|array $environment
5738
	 */
5739
	function verify_json_api_authorization_request( $environment = null ) {
5740
		$environment = is_null( $environment )
5741
			? $_REQUEST
5742
			: $environment;
5743
5744
		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...
5745
		$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...
5746
		if ( ! $token || empty( $token->secret ) ) {
5747
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5748
		}
5749
5750
		$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' );
5751
5752
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5753
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5754
			/**
5755
			 * Jetpack authorisation request Error.
5756
			 *
5757
			 * @since 7.5.0
5758
			 */
5759
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5760
			$die_error = sprintf(
5761
				/* translators: %s is a URL */
5762
				__( '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' ),
5763
				'https://jetpack.com/support/double-encoding/'
5764
			);
5765
		}
5766
5767
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5768
5769
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5770
			$signature = $jetpack_signature->sign_request(
5771
				$environment['token'],
5772
				$environment['timestamp'],
5773
				$environment['nonce'],
5774
				'',
5775
				'GET',
5776
				$environment['jetpack_json_api_original_query'],
5777
				null,
5778
				true
5779
			);
5780
		} else {
5781
			$signature = $jetpack_signature->sign_current_request(
5782
				array(
5783
					'body'   => null,
5784
					'method' => 'GET',
5785
				)
5786
			);
5787
		}
5788
5789
		if ( ! $signature ) {
5790
			wp_die( $die_error );
5791
		} elseif ( is_wp_error( $signature ) ) {
5792
			wp_die( $die_error );
5793
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
5794
			if ( is_ssl() ) {
5795
				// 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
5796
				$signature = $jetpack_signature->sign_current_request(
5797
					array(
5798
						'scheme' => 'http',
5799
						'body'   => null,
5800
						'method' => 'GET',
5801
					)
5802
				);
5803
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5804
					wp_die( $die_error );
5805
				}
5806
			} else {
5807
				wp_die( $die_error );
5808
			}
5809
		}
5810
5811
		$timestamp = (int) $environment['timestamp'];
5812
		$nonce     = stripslashes( (string) $environment['nonce'] );
5813
5814
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
5815
			// De-nonce the nonce, at least for 5 minutes.
5816
			// 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)
5817
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5818
			if ( $old_nonce_time < time() - 300 ) {
5819
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
5820
			}
5821
		}
5822
5823
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5824
		$data_filters = array(
5825
			'state'        => 'opaque',
5826
			'client_id'    => 'int',
5827
			'client_title' => 'string',
5828
			'client_image' => 'url',
5829
		);
5830
5831
		foreach ( $data_filters as $key => $sanitation ) {
5832
			if ( ! isset( $data->$key ) ) {
5833
				wp_die( $die_error );
5834
			}
5835
5836
			switch ( $sanitation ) {
5837
				case 'int':
5838
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
5839
					break;
5840
				case 'opaque':
5841
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
5842
					break;
5843
				case 'string':
5844
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
5845
					break;
5846
				case 'url':
5847
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
5848
					break;
5849
			}
5850
		}
5851
5852
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5853
			wp_die( $die_error );
5854
		}
5855
	}
5856
5857
	function login_message_json_api_authorization( $message ) {
5858
		return '<p class="message">' . sprintf(
5859
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
5860
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5861
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5862
	}
5863
5864
	/**
5865
	 * Get $content_width, but with a <s>twist</s> filter.
5866
	 */
5867
	public static function get_content_width() {
5868
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5869
			? $GLOBALS['content_width']
5870
			: false;
5871
		/**
5872
		 * Filter the Content Width value.
5873
		 *
5874
		 * @since 2.2.3
5875
		 *
5876
		 * @param string $content_width Content Width value.
5877
		 */
5878
		return apply_filters( 'jetpack_content_width', $content_width );
5879
	}
5880
5881
	/**
5882
	 * Pings the WordPress.com Mirror Site for the specified options.
5883
	 *
5884
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5885
	 *
5886
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5887
	 */
5888
	public function get_cloud_site_options( $option_names ) {
5889
		$option_names = array_filter( (array) $option_names, 'is_string' );
5890
5891
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
5892
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5893
		if ( $xml->isError() ) {
5894
			return array(
5895
				'error_code' => $xml->getErrorCode(),
5896
				'error_msg'  => $xml->getErrorMessage(),
5897
			);
5898
		}
5899
		$cloud_site_options = $xml->getResponse();
5900
5901
		return $cloud_site_options;
5902
	}
5903
5904
	/**
5905
	 * Checks if the site is currently in an identity crisis.
5906
	 *
5907
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5908
	 */
5909
	public static function check_identity_crisis() {
5910
		if ( ! self::is_active() || self::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5911
			return false;
5912
		}
5913
5914
		return Jetpack_Options::get_option( 'sync_error_idc' );
5915
	}
5916
5917
	/**
5918
	 * Checks whether the home and siteurl specifically are whitelisted
5919
	 * Written so that we don't have re-check $key and $value params every time
5920
	 * we want to check if this site is whitelisted, for example in footer.php
5921
	 *
5922
	 * @since  3.8.0
5923
	 * @return bool True = already whitelisted False = not whitelisted
5924
	 */
5925
	public static function is_staging_site() {
5926
		$is_staging = false;
5927
5928
		$known_staging = array(
5929
			'urls'      => array(
5930
				'#\.staging\.wpengine\.com$#i', // WP Engine
5931
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5932
				'#\.stage\.site$#i',            // DreamPress
5933
			),
5934
			'constants' => array(
5935
				'IS_WPE_SNAPSHOT',      // WP Engine
5936
				'KINSTA_DEV_ENV',       // Kinsta.com
5937
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5938
				'JETPACK_STAGING_MODE', // Generic
5939
			),
5940
		);
5941
		/**
5942
		 * Filters the flags of known staging sites.
5943
		 *
5944
		 * @since 3.9.0
5945
		 *
5946
		 * @param array $known_staging {
5947
		 *     An array of arrays that each are used to check if the current site is staging.
5948
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
5949
		 *     @type array $constants PHP constants of known staging/developement environments.
5950
		 *  }
5951
		 */
5952
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
5953
5954
		if ( isset( $known_staging['urls'] ) ) {
5955
			foreach ( $known_staging['urls'] as $url ) {
5956
				if ( preg_match( $url, site_url() ) ) {
5957
					$is_staging = true;
5958
					break;
5959
				}
5960
			}
5961
		}
5962
5963
		if ( isset( $known_staging['constants'] ) ) {
5964
			foreach ( $known_staging['constants'] as $constant ) {
5965
				if ( defined( $constant ) && constant( $constant ) ) {
5966
					$is_staging = true;
5967
				}
5968
			}
5969
		}
5970
5971
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
5972
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
5973
			$is_staging = true;
5974
		}
5975
5976
		/**
5977
		 * Filters is_staging_site check.
5978
		 *
5979
		 * @since 3.9.0
5980
		 *
5981
		 * @param bool $is_staging If the current site is a staging site.
5982
		 */
5983
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
5984
	}
5985
5986
	/**
5987
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5988
	 *
5989
	 * @since 4.4.0
5990
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
5991
	 *
5992
	 * @return bool
5993
	 */
5994
	public static function validate_sync_error_idc_option() {
5995
		$is_valid = false;
5996
5997
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
5998
		if ( false === $idc_allowed ) {
5999
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6000
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6001
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6002
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6003
				$transient_duration = HOUR_IN_SECONDS;
6004
			} else {
6005
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6006
				$idc_allowed        = '1';
6007
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6008
			}
6009
6010
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6011
		}
6012
6013
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6014
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6015
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6016
			$local_options = self::get_sync_error_idc_option();
6017
			// Ensure all values are set.
6018
			if ( isset( $sync_error['home'] ) && isset ( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6019
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6020
					$is_valid = true;
6021
				}
6022
			}
6023
6024
		}
6025
6026
		/**
6027
		 * Filters whether the sync_error_idc option is valid.
6028
		 *
6029
		 * @since 4.4.0
6030
		 *
6031
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6032
		 */
6033
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6034
6035
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6036
			// Since the option exists, and did not validate, delete it
6037
			Jetpack_Options::delete_option( 'sync_error_idc' );
6038
		}
6039
6040
		return $is_valid;
6041
	}
6042
6043
	/**
6044
	 * Normalizes a url by doing three things:
6045
	 *  - Strips protocol
6046
	 *  - Strips www
6047
	 *  - Adds a trailing slash
6048
	 *
6049
	 * @since 4.4.0
6050
	 * @param string $url
6051
	 * @return WP_Error|string
6052
	 */
6053
	public static function normalize_url_protocol_agnostic( $url ) {
6054
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6055
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6056
			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...
6057
		}
6058
6059
		// Strip www and protocols
6060
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6061
		return $url;
6062
	}
6063
6064
	/**
6065
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6066
	 *
6067
	 * @since 4.4.0
6068
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6069
	 *
6070
	 * @param array $response
6071
	 * @return array Array of the local urls, wpcom urls, and error code
6072
	 */
6073
	public static function get_sync_error_idc_option( $response = array() ) {
6074
		// Since the local options will hit the database directly, store the values
6075
		// in a transient to allow for autoloading and caching on subsequent views.
6076
		$local_options = get_transient( 'jetpack_idc_local' );
6077
		if ( false === $local_options ) {
6078
			$local_options = array(
6079
				'home'    => Functions::home_url(),
6080
				'siteurl' => Functions::site_url(),
6081
			);
6082
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6083
		}
6084
6085
		$options = array_merge( $local_options, $response );
6086
6087
		$returned_values = array();
6088
		foreach ( $options as $key => $option ) {
6089
			if ( 'error_code' === $key ) {
6090
				$returned_values[ $key ] = $option;
6091
				continue;
6092
			}
6093
6094
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6095
				continue;
6096
			}
6097
6098
			$returned_values[ $key ] = $normalized_url;
6099
		}
6100
6101
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6102
6103
		return $returned_values;
6104
	}
6105
6106
	/**
6107
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6108
	 * If set to true, the site will be put into staging mode.
6109
	 *
6110
	 * @since 4.3.2
6111
	 * @return bool
6112
	 */
6113
	public static function sync_idc_optin() {
6114
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6115
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6116
		} else {
6117
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6118
		}
6119
6120
		/**
6121
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6122
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6123
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6124
		 *
6125
		 * @since 4.3.2
6126
		 *
6127
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6128
		 */
6129
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6130
	}
6131
6132
	/**
6133
	 * Maybe Use a .min.css stylesheet, maybe not.
6134
	 *
6135
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6136
	 */
6137
	public static function maybe_min_asset( $url, $path, $plugin ) {
6138
		// Short out on things trying to find actual paths.
6139
		if ( ! $path || empty( $plugin ) ) {
6140
			return $url;
6141
		}
6142
6143
		$path = ltrim( $path, '/' );
6144
6145
		// Strip out the abspath.
6146
		$base = dirname( plugin_basename( $plugin ) );
6147
6148
		// Short out on non-Jetpack assets.
6149
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6150
			return $url;
6151
		}
6152
6153
		// File name parsing.
6154
		$file              = "{$base}/{$path}";
6155
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6156
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6157
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6158
		$extension         = array_shift( $file_name_parts_r );
6159
6160
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6161
			// Already pointing at the minified version.
6162
			if ( 'min' === $file_name_parts_r[0] ) {
6163
				return $url;
6164
			}
6165
6166
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6167
			if ( file_exists( $min_full_path ) ) {
6168
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6169
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6170
				if ( 'css' === $extension ) {
6171
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6172
					self::$min_assets[ $key ] = $path;
6173
				}
6174
			}
6175
		}
6176
6177
		return $url;
6178
	}
6179
6180
	/**
6181
	 * If the asset is minified, let's flag .min as the suffix.
6182
	 *
6183
	 * Attached to `style_loader_src` filter.
6184
	 *
6185
	 * @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...
6186
	 * @param string $handle The registered handle of the script in question.
6187
	 * @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...
6188
	 */
6189
	public static function set_suffix_on_min( $src, $handle ) {
6190
		if ( false === strpos( $src, '.min.css' ) ) {
6191
			return $src;
6192
		}
6193
6194
		if ( ! empty( self::$min_assets ) ) {
6195
			foreach ( self::$min_assets as $file => $path ) {
6196
				if ( false !== strpos( $src, $file ) ) {
6197
					wp_style_add_data( $handle, 'suffix', '.min' );
6198
					return $src;
6199
				}
6200
			}
6201
		}
6202
6203
		return $src;
6204
	}
6205
6206
	/**
6207
	 * Maybe inlines a stylesheet.
6208
	 *
6209
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6210
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6211
	 *
6212
	 * Attached to `style_loader_tag` filter.
6213
	 *
6214
	 * @param string $tag The tag that would link to the external asset.
6215
	 * @param string $handle The registered handle of the script in question.
6216
	 *
6217
	 * @return string
6218
	 */
6219
	public static function maybe_inline_style( $tag, $handle ) {
6220
		global $wp_styles;
6221
		$item = $wp_styles->registered[ $handle ];
6222
6223
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6224
			return $tag;
6225
		}
6226
6227
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6228
			$href = $matches[1];
6229
			// Strip off query string
6230
			if ( $pos = strpos( $href, '?' ) ) {
6231
				$href = substr( $href, 0, $pos );
6232
			}
6233
			// Strip off fragment
6234
			if ( $pos = strpos( $href, '#' ) ) {
6235
				$href = substr( $href, 0, $pos );
6236
			}
6237
		} else {
6238
			return $tag;
6239
		}
6240
6241
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6242
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6243
			return $tag;
6244
		}
6245
6246
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6247
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6248
			// And this isn't the pass that actually deals with the RTL version...
6249
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6250
				// Short out, as the RTL version will deal with it in a moment.
6251
				return $tag;
6252
			}
6253
		}
6254
6255
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6256
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6257
		if ( $css ) {
6258
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6259
			if ( empty( $item->extra['after'] ) ) {
6260
				wp_add_inline_style( $handle, $css );
6261
			} else {
6262
				array_unshift( $item->extra['after'], $css );
6263
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6264
			}
6265
		}
6266
6267
		return $tag;
6268
	}
6269
6270
	/**
6271
	 * Loads a view file from the views
6272
	 *
6273
	 * Data passed in with the $data parameter will be available in the
6274
	 * template file as $data['value']
6275
	 *
6276
	 * @param string $template - Template file to load
6277
	 * @param array  $data - Any data to pass along to the template
6278
	 * @return boolean - If template file was found
6279
	 **/
6280
	public function load_view( $template, $data = array() ) {
6281
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6282
6283
		if ( file_exists( $views_dir . $template ) ) {
6284
			require_once $views_dir . $template;
6285
			return true;
6286
		}
6287
6288
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6289
		return false;
6290
	}
6291
6292
	/**
6293
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6294
	 */
6295
	public function deprecated_hooks() {
6296
		global $wp_filter;
6297
6298
		/*
6299
		 * Format:
6300
		 * deprecated_filter_name => replacement_name
6301
		 *
6302
		 * If there is no replacement, use null for replacement_name
6303
		 */
6304
		$deprecated_list = array(
6305
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6306
			'wpl_sharing_2014_1'                           => null,
6307
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6308
			'jetpack_identity_crisis_options_to_check'     => null,
6309
			'update_option_jetpack_single_user_site'       => null,
6310
			'audio_player_default_colors'                  => null,
6311
			'add_option_jetpack_featured_images_enabled'   => null,
6312
			'add_option_jetpack_update_details'            => null,
6313
			'add_option_jetpack_updates'                   => null,
6314
			'add_option_jetpack_network_name'              => null,
6315
			'add_option_jetpack_network_allow_new_registrations' => null,
6316
			'add_option_jetpack_network_add_new_users'     => null,
6317
			'add_option_jetpack_network_site_upload_space' => null,
6318
			'add_option_jetpack_network_upload_file_types' => null,
6319
			'add_option_jetpack_network_enable_administration_menus' => null,
6320
			'add_option_jetpack_is_multi_site'             => null,
6321
			'add_option_jetpack_is_main_network'           => null,
6322
			'add_option_jetpack_main_network_site'         => null,
6323
			'jetpack_sync_all_registered_options'          => null,
6324
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6325
			'jetpack_is_post_mailable'                     => null,
6326
			'jetpack_seo_site_host'                        => null,
6327
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6328
			'jetpack_holiday_snow_option_name'             => null,
6329
			'jetpack_holiday_chance_of_snow'               => null,
6330
			'jetpack_holiday_snow_js_url'                  => null,
6331
			'jetpack_is_holiday_snow_season'               => null,
6332
			'jetpack_holiday_snow_option_updated'          => null,
6333
			'jetpack_holiday_snowing'                      => null,
6334
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6335
			'jetpack_cache_plans'                          => null,
6336
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6337
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6338
			'jetpack_enable_site_verification'             => null,
6339
			'can_display_jetpack_manage_notice'            => null,
6340
			// Removed in Jetpack 7.3.0
6341
			'atd_load_scripts'                             => null,
6342
			'atd_http_post_timeout'                        => null,
6343
			'atd_http_post_error'                          => null,
6344
			'atd_service_domain'                           => null,
6345
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6346
			// Removed in Jetpack 7.9.0
6347
			'jetpack_pwa_manifest'                         => null,
6348
			'jetpack_pwa_background_color'                 => null,
6349
		);
6350
6351
		// This is a silly loop depth. Better way?
6352
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6353
			if ( has_action( $hook ) ) {
6354
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6355
					foreach ( $values as $hooked ) {
6356
						if ( is_callable( $hooked['function'] ) ) {
6357
							$function_name = 'an anonymous function';
6358
						} else {
6359
							$function_name = $hooked['function'];
6360
						}
6361
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6362
					}
6363
				}
6364
			}
6365
		}
6366
	}
6367
6368
	/**
6369
	 * Converts any url in a stylesheet, to the correct absolute url.
6370
	 *
6371
	 * Considerations:
6372
	 *  - Normal, relative URLs     `feh.png`
6373
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6374
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6375
	 *  - Absolute URLs             `http://domain.com/feh.png`
6376
	 *  - Domain root relative URLs `/feh.png`
6377
	 *
6378
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6379
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6380
	 *
6381
	 * @return mixed|string
6382
	 */
6383
	public static function absolutize_css_urls( $css, $css_file_url ) {
6384
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6385
		$css_dir = dirname( $css_file_url );
6386
		$p       = parse_url( $css_dir );
6387
		$domain  = sprintf(
6388
			'%1$s//%2$s%3$s%4$s',
6389
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6390
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6391
			$p['host'],
6392
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6393
		);
6394
6395
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6396
			$find = $replace = array();
6397
			foreach ( $matches as $match ) {
6398
				$url = trim( $match['path'], "'\" \t" );
6399
6400
				// If this is a data url, we don't want to mess with it.
6401
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6402
					continue;
6403
				}
6404
6405
				// If this is an absolute or protocol-agnostic url,
6406
				// we don't want to mess with it.
6407
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6408
					continue;
6409
				}
6410
6411
				switch ( substr( $url, 0, 1 ) ) {
6412
					case '/':
6413
						$absolute = $domain . $url;
6414
						break;
6415
					default:
6416
						$absolute = $css_dir . '/' . $url;
6417
				}
6418
6419
				$find[]    = $match[0];
6420
				$replace[] = sprintf( 'url("%s")', $absolute );
6421
			}
6422
			$css = str_replace( $find, $replace, $css );
6423
		}
6424
6425
		return $css;
6426
	}
6427
6428
	/**
6429
	 * This methods removes all of the registered css files on the front end
6430
	 * from Jetpack in favor of using a single file. In effect "imploding"
6431
	 * all the files into one file.
6432
	 *
6433
	 * Pros:
6434
	 * - Uses only ONE css asset connection instead of 15
6435
	 * - Saves a minimum of 56k
6436
	 * - Reduces server load
6437
	 * - Reduces time to first painted byte
6438
	 *
6439
	 * Cons:
6440
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6441
	 *      should not cause any issues with themes.
6442
	 * - Plugins/themes dequeuing styles no longer do anything. See
6443
	 *      jetpack_implode_frontend_css filter for a workaround
6444
	 *
6445
	 * For some situations developers may wish to disable css imploding and
6446
	 * instead operate in legacy mode where each file loads seperately and
6447
	 * can be edited individually or dequeued. This can be accomplished with
6448
	 * the following line:
6449
	 *
6450
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6451
	 *
6452
	 * @since 3.2
6453
	 **/
6454
	public function implode_frontend_css( $travis_test = false ) {
6455
		$do_implode = true;
6456
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6457
			$do_implode = false;
6458
		}
6459
6460
		// Do not implode CSS when the page loads via the AMP plugin.
6461
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6462
			$do_implode = false;
6463
		}
6464
6465
		/**
6466
		 * Allow CSS to be concatenated into a single jetpack.css file.
6467
		 *
6468
		 * @since 3.2.0
6469
		 *
6470
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6471
		 */
6472
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6473
6474
		// Do not use the imploded file when default behavior was altered through the filter
6475
		if ( ! $do_implode ) {
6476
			return;
6477
		}
6478
6479
		// We do not want to use the imploded file in dev mode, or if not connected
6480
		if ( self::is_development_mode() || ! self::is_active() ) {
6481
			if ( ! $travis_test ) {
6482
				return;
6483
			}
6484
		}
6485
6486
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6487
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6488
			return;
6489
		}
6490
6491
		/*
6492
		 * Now we assume Jetpack is connected and able to serve the single
6493
		 * file.
6494
		 *
6495
		 * In the future there will be a check here to serve the file locally
6496
		 * or potentially from the Jetpack CDN
6497
		 *
6498
		 * For now:
6499
		 * - Enqueue a single imploded css file
6500
		 * - Zero out the style_loader_tag for the bundled ones
6501
		 * - Be happy, drink scotch
6502
		 */
6503
6504
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6505
6506
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6507
6508
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6509
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6510
	}
6511
6512
	function concat_remove_style_loader_tag( $tag, $handle ) {
6513
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6514
			$tag = '';
6515
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6516
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6517
			}
6518
		}
6519
6520
		return $tag;
6521
	}
6522
6523
	/**
6524
	 * Add an async attribute to scripts that can be loaded asynchronously.
6525
	 * https://www.w3schools.com/tags/att_script_async.asp
6526
	 *
6527
	 * @since 7.7.0
6528
	 *
6529
	 * @param string $tag    The <script> tag for the enqueued script.
6530
	 * @param string $handle The script's registered handle.
6531
	 * @param string $src    The script's source URL.
6532
	 */
6533
	public function script_add_async( $tag, $handle, $src ) {
6534
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6535
			return preg_replace( '/^<script /i', '<script async ', $tag );
6536
		}
6537
6538
		return $tag;
6539
	}
6540
6541
	/*
6542
	 * Check the heartbeat data
6543
	 *
6544
	 * Organizes the heartbeat data by severity.  For example, if the site
6545
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6546
	 *
6547
	 * Data will be added to "caution" array, if it either:
6548
	 *  - Out of date Jetpack version
6549
	 *  - Out of date WP version
6550
	 *  - Out of date PHP version
6551
	 *
6552
	 * $return array $filtered_data
6553
	 */
6554
	public static function jetpack_check_heartbeat_data() {
6555
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6556
6557
		$good    = array();
6558
		$caution = array();
6559
		$bad     = array();
6560
6561
		foreach ( $raw_data as $stat => $value ) {
6562
6563
			// Check jetpack version
6564
			if ( 'version' == $stat ) {
6565
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6566
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6567
					continue;
6568
				}
6569
			}
6570
6571
			// Check WP version
6572
			if ( 'wp-version' == $stat ) {
6573
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6574
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6575
					continue;
6576
				}
6577
			}
6578
6579
			// Check PHP version
6580
			if ( 'php-version' == $stat ) {
6581
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6582
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_PHP_VERSION;
6583
					continue;
6584
				}
6585
			}
6586
6587
			// Check ID crisis
6588
			if ( 'identitycrisis' == $stat ) {
6589
				if ( 'yes' == $value ) {
6590
					$bad[ $stat ] = $value;
6591
					continue;
6592
				}
6593
			}
6594
6595
			// The rest are good :)
6596
			$good[ $stat ] = $value;
6597
		}
6598
6599
		$filtered_data = array(
6600
			'good'    => $good,
6601
			'caution' => $caution,
6602
			'bad'     => $bad,
6603
		);
6604
6605
		return $filtered_data;
6606
	}
6607
6608
6609
	/*
6610
	 * This method is used to organize all options that can be reset
6611
	 * without disconnecting Jetpack.
6612
	 *
6613
	 * It is used in class.jetpack-cli.php to reset options
6614
	 *
6615
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6616
	 *
6617
	 * @return array of options to delete.
6618
	 */
6619
	public static function get_jetpack_options_for_reset() {
6620
		return Jetpack_Options::get_options_for_reset();
6621
	}
6622
6623
	/*
6624
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6625
	 * so we can bring them directly to their site in calypso.
6626
	 *
6627
	 * @param string | url
6628
	 * @return string | url without the guff
6629
	 */
6630
	public static function build_raw_urls( $url ) {
6631
		$strip_http = '/.*?:\/\//i';
6632
		$url        = preg_replace( $strip_http, '', $url );
6633
		$url        = str_replace( '/', '::', $url );
6634
		return $url;
6635
	}
6636
6637
	/**
6638
	 * Stores and prints out domains to prefetch for page speed optimization.
6639
	 *
6640
	 * @param mixed $new_urls
6641
	 */
6642
	public static function dns_prefetch( $new_urls = null ) {
6643
		static $prefetch_urls = array();
6644
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6645
			echo "\r\n";
6646
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6647
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6648
			}
6649
		} elseif ( ! empty( $new_urls ) ) {
6650
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6651
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6652
			}
6653
			foreach ( (array) $new_urls as $this_new_url ) {
6654
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6655
			}
6656
			$prefetch_urls = array_unique( $prefetch_urls );
6657
		}
6658
	}
6659
6660
	public function wp_dashboard_setup() {
6661
		if ( self::is_active() ) {
6662
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6663
		}
6664
6665
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6666
			$jetpack_logo = new Jetpack_Logo();
6667
			$widget_title = sprintf(
6668
				wp_kses(
6669
					/* translators: Placeholder is a Jetpack logo. */
6670
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6671
					array( 'span' => array() )
6672
				),
6673
				$jetpack_logo->get_jp_emblem( true )
6674
			);
6675
6676
			wp_add_dashboard_widget(
6677
				'jetpack_summary_widget',
6678
				$widget_title,
6679
				array( __CLASS__, 'dashboard_widget' )
6680
			);
6681
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6682
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6683
6684
			// If we're inactive and not in development mode, sort our box to the top.
6685
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6686
				global $wp_meta_boxes;
6687
6688
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6689
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6690
6691
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6692
			}
6693
		}
6694
	}
6695
6696
	/**
6697
	 * @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...
6698
	 * @return mixed
6699
	 */
6700
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6701
		if ( ! is_array( $sorted ) ) {
6702
			return $sorted;
6703
		}
6704
6705
		foreach ( $sorted as $box_context => $ids ) {
6706
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6707
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6708
				continue;
6709
			}
6710
6711
			$ids_array = explode( ',', $ids );
6712
			$key       = array_search( 'dashboard_stats', $ids_array );
6713
6714
			if ( false !== $key ) {
6715
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6716
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6717
				$sorted[ $box_context ] = implode( ',', $ids_array );
6718
				// We've found it, stop searching, and just return.
6719
				break;
6720
			}
6721
		}
6722
6723
		return $sorted;
6724
	}
6725
6726
	public static function dashboard_widget() {
6727
		/**
6728
		 * Fires when the dashboard is loaded.
6729
		 *
6730
		 * @since 3.4.0
6731
		 */
6732
		do_action( 'jetpack_dashboard_widget' );
6733
	}
6734
6735
	public static function dashboard_widget_footer() {
6736
		?>
6737
		<footer>
6738
6739
		<div class="protect">
6740
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6741
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6742
				<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>
6743
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6744
				<a href="
6745
				<?php
6746
				echo esc_url(
6747
					wp_nonce_url(
6748
						self::admin_url(
6749
							array(
6750
								'action' => 'activate',
6751
								'module' => 'protect',
6752
							)
6753
						),
6754
						'jetpack_activate-protect'
6755
					)
6756
				);
6757
				?>
6758
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6759
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6760
				</a>
6761
			<?php else : ?>
6762
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6763
			<?php endif; ?>
6764
		</div>
6765
6766
		<div class="akismet">
6767
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6768
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6769
				<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>
6770
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6771
				<a href="
6772
				<?php
6773
				echo esc_url(
6774
					wp_nonce_url(
6775
						add_query_arg(
6776
							array(
6777
								'action' => 'activate',
6778
								'plugin' => 'akismet/akismet.php',
6779
							),
6780
							admin_url( 'plugins.php' )
6781
						),
6782
						'activate-plugin_akismet/akismet.php'
6783
					)
6784
				);
6785
				?>
6786
							" class="button button-jetpack">
6787
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6788
				</a>
6789
			<?php else : ?>
6790
				<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>
6791
			<?php endif; ?>
6792
		</div>
6793
6794
		</footer>
6795
		<?php
6796
	}
6797
6798
	/*
6799
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6800
	 */
6801
	function jetpack_icon_user_connected( $columns ) {
6802
		$columns['user_jetpack'] = '';
6803
		return $columns;
6804
	}
6805
6806
	/*
6807
	 * Show Jetpack icon if the user is linked.
6808
	 */
6809
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6810
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
6811
			$jetpack_logo = new Jetpack_Logo();
6812
			$emblem_html  = sprintf(
6813
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6814
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6815
				$jetpack_logo->get_jp_emblem()
6816
			);
6817
			return $emblem_html;
6818
		}
6819
6820
		return $val;
6821
	}
6822
6823
	/*
6824
	 * Style the Jetpack user column
6825
	 */
6826
	function jetpack_user_col_style() {
6827
		global $current_screen;
6828
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
6829
			?>
6830
			<style>
6831
				.fixed .column-user_jetpack {
6832
					width: 21px;
6833
				}
6834
				.jp-emblem-user-admin svg {
6835
					width: 20px;
6836
					height: 20px;
6837
				}
6838
				.jp-emblem-user-admin path {
6839
					fill: #00BE28;
6840
				}
6841
			</style>
6842
			<?php
6843
		}
6844
	}
6845
6846
	/**
6847
	 * Checks if Akismet is active and working.
6848
	 *
6849
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6850
	 * that implied usage of methods present since more recent version.
6851
	 * See https://github.com/Automattic/jetpack/pull/9585
6852
	 *
6853
	 * @since  5.1.0
6854
	 *
6855
	 * @return bool True = Akismet available. False = Aksimet not available.
6856
	 */
6857
	public static function is_akismet_active() {
6858
		static $status = null;
6859
6860
		if ( ! is_null( $status ) ) {
6861
			return $status;
6862
		}
6863
6864
		// Check if a modern version of Akismet is active.
6865
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6866
			$status = false;
6867
			return $status;
6868
		}
6869
6870
		// Make sure there is a key known to Akismet at all before verifying key.
6871
		$akismet_key = Akismet::get_api_key();
6872
		if ( ! $akismet_key ) {
6873
			$status = false;
6874
			return $status;
6875
		}
6876
6877
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6878
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6879
6880
		// 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.
6881
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6882
		// We cache the result of the Akismet key verification for ten minutes.
6883
		if ( ! $akismet_key_state || $recheck ) {
6884
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6885
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6886
		}
6887
6888
		$status = 'valid' === $akismet_key_state;
6889
6890
		return $status;
6891
	}
6892
6893
	/**
6894
	 * @deprecated
6895
	 *
6896
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
6897
	 */
6898
	public static function is_function_in_backtrace() {
6899
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
6900
	}
6901
6902
	/**
6903
	 * Given a minified path, and a non-minified path, will return
6904
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6905
	 *
6906
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6907
	 * root Jetpack directory.
6908
	 *
6909
	 * @since 5.6.0
6910
	 *
6911
	 * @param string $min_path
6912
	 * @param string $non_min_path
6913
	 * @return string The URL to the file
6914
	 */
6915
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6916
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
6917
	}
6918
6919
	/**
6920
	 * Checks for whether Jetpack Backup & Scan is enabled.
6921
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
6922
	 *
6923
	 * @return bool|int|mixed
6924
	 */
6925
	public static function is_rewind_enabled() {
6926
		if ( ! self::is_active() ) {
6927
			return false;
6928
		}
6929
6930
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6931
		if ( false === $rewind_enabled ) {
6932
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6933
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6934
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
6935
				&& ! empty( $rewind_data['state'] )
6936
				&& 'active' === $rewind_data['state'] )
6937
				? 1
6938
				: 0;
6939
6940
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
6941
		}
6942
		return $rewind_enabled;
6943
	}
6944
6945
	/**
6946
	 * Return Calypso environment value; used for developing Jetpack and pairing
6947
	 * it with different Calypso enrionments, such as localhost.
6948
	 *
6949
	 * @since 7.4.0
6950
	 *
6951
	 * @return string Calypso environment
6952
	 */
6953
	public static function get_calypso_env() {
6954
		if ( isset( $_GET['calypso_env'] ) ) {
6955
			return sanitize_key( $_GET['calypso_env'] );
6956
		}
6957
6958
		if ( getenv( 'CALYPSO_ENV' ) ) {
6959
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
6960
		}
6961
6962
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
6963
			return sanitize_key( CALYPSO_ENV );
6964
		}
6965
6966
		return '';
6967
	}
6968
6969
	/**
6970
	 * Checks whether or not TOS has been agreed upon.
6971
	 * Will return true if a user has clicked to register, or is already connected.
6972
	 */
6973
	public static function jetpack_tos_agreed() {
6974
		return Jetpack_Options::get_option( 'tos_agreed' ) || self::is_active();
6975
	}
6976
6977
	/**
6978
	 * Handles activating default modules as well general cleanup for the new connection.
6979
	 *
6980
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
6981
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
6982
	 * @param boolean $send_state_messages          Whether to send state messages.
6983
	 * @return void
6984
	 */
6985
	public static function handle_post_authorization_actions(
6986
		$activate_sso = false,
6987
		$redirect_on_activation_error = false,
6988
		$send_state_messages = true
6989
	) {
6990
		$other_modules = $activate_sso
6991
			? array( 'sso' )
6992
			: array();
6993
6994
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
6995
			self::delete_active_modules();
6996
6997
			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...
6998
		} else {
6999
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7000
		}
7001
7002
		// Since this is a fresh connection, be sure to clear out IDC options
7003
		Jetpack_IDC::clear_all_idc_options();
7004
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7005
7006
		// Start nonce cleaner
7007
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7008
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7009
7010
		if ( $send_state_messages ) {
7011
			self::state( 'message', 'authorized' );
7012
		}
7013
	}
7014
7015
	/**
7016
	 * Returns a boolean for whether backups UI should be displayed or not.
7017
	 *
7018
	 * @return bool Should backups UI be displayed?
7019
	 */
7020
	public static function show_backups_ui() {
7021
		/**
7022
		 * Whether UI for backups should be displayed.
7023
		 *
7024
		 * @since 6.5.0
7025
		 *
7026
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7027
		 */
7028
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7029
	}
7030
7031
	/*
7032
	 * Deprecated manage functions
7033
	 */
7034
	function prepare_manage_jetpack_notice() {
7035
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7036
	}
7037
	function manage_activate_screen() {
7038
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7039
	}
7040
	function admin_jetpack_manage_notice() {
7041
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7042
	}
7043
	function opt_out_jetpack_manage_url() {
7044
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7045
	}
7046
	function opt_in_jetpack_manage_url() {
7047
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7048
	}
7049
	function opt_in_jetpack_manage_notice() {
7050
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7051
	}
7052
	function can_display_jetpack_manage_notice() {
7053
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7054
	}
7055
7056
	/**
7057
	 * Clean leftoveruser meta.
7058
	 *
7059
	 * Delete Jetpack-related user meta when it is no longer needed.
7060
	 *
7061
	 * @since 7.3.0
7062
	 *
7063
	 * @param int $user_id User ID being updated.
7064
	 */
7065
	public static function user_meta_cleanup( $user_id ) {
7066
		$meta_keys = array(
7067
			// AtD removed from Jetpack 7.3
7068
			'AtD_options',
7069
			'AtD_check_when',
7070
			'AtD_guess_lang',
7071
			'AtD_ignored_phrases',
7072
		);
7073
7074
		foreach ( $meta_keys as $meta_key ) {
7075
			if ( get_user_meta( $user_id, $meta_key ) ) {
7076
				delete_user_meta( $user_id, $meta_key );
7077
			}
7078
		}
7079
	}
7080
7081
	function is_active_and_not_development_mode( $maybe ) {
7082
		if ( ! self::is_active() || self::is_development_mode() ) {
7083
			return false;
7084
		}
7085
		return true;
7086
	}
7087
}
7088