Completed
Push — add/sync-health ( ec7404...f17abd )
by
unknown
42:42 queued 35:48
created

class.jetpack.php (64 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\Config;
5
use Automattic\Jetpack\Connection\Client;
6
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
7
use Automattic\Jetpack\Connection\Utils as Connection_Utils;
8
use Automattic\Jetpack\Constants;
9
use Automattic\Jetpack\Partner;
10
use Automattic\Jetpack\Roles;
11
use Automattic\Jetpack\Status;
12
use Automattic\Jetpack\Sync\Functions;
13
use Automattic\Jetpack\Sync\Health;
14
use Automattic\Jetpack\Sync\Sender;
15
use Automattic\Jetpack\Sync\Users;
16
use Automattic\Jetpack\Terms_Of_Service;
17
use Automattic\Jetpack\Tracking;
18
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
19
20
/*
21
Options:
22
jetpack_options (array)
23
	An array of options.
24
	@see Jetpack_Options::get_option_names()
25
26
jetpack_register (string)
27
	Temporary verification secrets.
28
29
jetpack_activated (int)
30
	1: the plugin was activated normally
31
	2: the plugin was activated on this site because of a network-wide activation
32
	3: the plugin was auto-installed
33
	4: the plugin was manually disconnected (but is still installed)
34
35
jetpack_active_modules (array)
36
	Array of active module slugs.
37
38
jetpack_do_activate (bool)
39
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
40
*/
41
42
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
43
44
class Jetpack {
45
	public $xmlrpc_server = null;
46
47
	private $rest_authentication_status = null;
48
49
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
50
51
	/**
52
	 * @var array The handles of styles that are concatenated into jetpack.css.
53
	 *
54
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
55
	 */
56
	public $concatenated_style_handles = array(
57
		'jetpack-carousel',
58
		'grunion.css',
59
		'the-neverending-homepage',
60
		'jetpack_likes',
61
		'jetpack_related-posts',
62
		'sharedaddy',
63
		'jetpack-slideshow',
64
		'presentations',
65
		'quiz',
66
		'jetpack-subscriptions',
67
		'jetpack-responsive-videos-style',
68
		'jetpack-social-menu',
69
		'tiled-gallery',
70
		'jetpack_display_posts_widget',
71
		'gravatar-profile-widget',
72
		'goodreads-widget',
73
		'jetpack_social_media_icons_widget',
74
		'jetpack-top-posts-widget',
75
		'jetpack_image_widget',
76
		'jetpack-my-community-widget',
77
		'jetpack-authors-widget',
78
		'wordads',
79
		'eu-cookie-law-style',
80
		'flickr-widget-style',
81
		'jetpack-search-widget',
82
		'jetpack-simple-payments-widget-style',
83
		'jetpack-widget-social-icons-styles',
84
	);
85
86
	/**
87
	 * The handles of scripts that can be loaded asynchronously.
88
	 *
89
	 * @var array
90
	 */
91
	public $async_script_handles = array(
92
		'woocommerce-analytics',
93
	);
94
95
	/**
96
	 * Contains all assets that have had their URL rewritten to minified versions.
97
	 *
98
	 * @var array
99
	 */
100
	static $min_assets = array();
101
102
	public $plugins_to_deactivate = array(
103
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
104
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
105
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
106
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
107
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
108
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
109
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
110
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
111
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
112
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
113
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
114
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
115
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
116
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
117
	);
118
119
	/**
120
	 * Map of roles we care about, and their corresponding minimum capabilities.
121
	 *
122
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
123
	 *
124
	 * @access public
125
	 * @static
126
	 *
127
	 * @var array
128
	 */
129
	public static $capability_translations = array(
130
		'administrator' => 'manage_options',
131
		'editor'        => 'edit_others_posts',
132
		'author'        => 'publish_posts',
133
		'contributor'   => 'edit_posts',
134
		'subscriber'    => 'read',
135
	);
136
137
	/**
138
	 * Map of modules that have conflicts with plugins and should not be auto-activated
139
	 * if the plugins are active.  Used by filter_default_modules
140
	 *
141
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
142
	 * change `module-slug` and add this to your plugin:
143
	 *
144
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
145
	 * function my_jetpack_get_default_modules( $modules ) {
146
	 *     return array_diff( $modules, array( 'module-slug' ) );
147
	 * }
148
	 *
149
	 * @var array
150
	 */
151
	private $conflicting_plugins = array(
152
		'comments'           => array(
153
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
154
			'Disqus'                         => 'disqus-comment-system/disqus.php',
155
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
156
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
157
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
158
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
159
		),
160
		'comment-likes'      => array(
161
			'Epoch' => 'epoch/plugincore.php',
162
		),
163
		'contact-form'       => array(
164
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
165
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
166
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
167
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
168
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
169
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
170
		),
171
		'minileven'          => array(
172
			'WPtouch' => 'wptouch/wptouch.php',
173
		),
174
		'latex'              => array(
175
			'LaTeX for WordPress'     => 'latex/latex.php',
176
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
177
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
178
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
179
			'Enable Latex'            => 'enable-latex/enable-latex.php',
180
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
181
		),
182
		'protect'            => array(
183
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
184
			'Captcha'                           => 'captcha/captcha.php',
185
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
186
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
187
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
188
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
189
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
190
			'Security-protection'               => 'security-protection/security-protection.php',
191
			'Login Security'                    => 'login-security/login-security.php',
192
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
193
			'Wordfence Security'                => 'wordfence/wordfence.php',
194
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
195
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
196
		),
197
		'random-redirect'    => array(
198
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
199
		),
200
		'related-posts'      => array(
201
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
202
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
203
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
204
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
205
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
206
			'outbrain'                    => 'outbrain/outbrain.php',
207
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
208
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
209
		),
210
		'sharedaddy'         => array(
211
			'AddThis'     => 'addthis/addthis_social_widget.php',
212
			'Add To Any'  => 'add-to-any/add-to-any.php',
213
			'ShareThis'   => 'share-this/sharethis.php',
214
			'Shareaholic' => 'shareaholic/shareaholic.php',
215
		),
216
		'seo-tools'          => array(
217
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
218
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
219
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
220
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
221
			'The SEO Framework'              => 'autodescription/autodescription.php',
222
		),
223
		'verification-tools' => array(
224
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
225
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
226
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
227
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
228
			'The SEO Framework'              => 'autodescription/autodescription.php',
229
		),
230
		'widget-visibility'  => array(
231
			'Widget Logic'    => 'widget-logic/widget_logic.php',
232
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
233
		),
234
		'sitemaps'           => array(
235
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
236
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
237
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
238
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
239
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
240
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
241
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
242
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
243
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
244
			'The SEO Framework'                    => 'autodescription/autodescription.php',
245
			'Sitemap'                              => 'sitemap/sitemap.php',
246
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
247
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
248
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
249
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
250
		),
251
		'lazy-images'        => array(
252
			'Lazy Load'              => 'lazy-load/lazy-load.php',
253
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
254
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
255
		),
256
	);
257
258
	/**
259
	 * Plugins for which we turn off our Facebook OG Tags implementation.
260
	 *
261
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
262
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
263
	 *
264
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
265
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
266
	 */
267
	private $open_graph_conflicting_plugins = array(
268
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
269
		// 2 Click Social Media Buttons
270
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
271
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
272
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
273
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
274
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
275
		// Open Graph Meta Tags by Heateor
276
		'facebook/facebook.php',                                 // Facebook (official plugin)
277
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
278
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
279
		// Facebook Featured Image & OG Meta Tags
280
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
281
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
282
		// Facebook Open Graph Meta Tags for WordPress
283
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
284
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
285
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
286
		// Fedmich's Facebook Open Graph Meta
287
		'network-publisher/networkpub.php',                      // Network Publisher
288
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
289
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
290
		// NextScripts SNAP
291
		'og-tags/og-tags.php',                                   // OG Tags
292
		'opengraph/opengraph.php',                               // Open Graph
293
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
294
		// Open Graph Protocol Framework
295
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
296
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
297
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
298
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
299
		'sharepress/sharepress.php',                             // SharePress
300
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
301
		'social-discussions/social-discussions.php',             // Social Discussions
302
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
303
		'socialize/socialize.php',                               // Socialize
304
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
305
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
306
		// Tweet, Like, Google +1 and Share
307
		'wordbooker/wordbooker.php',                             // Wordbooker
308
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
309
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
310
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
311
		// WP Facebook Like Send & Open Graph Meta
312
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
313
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
314
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
315
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
316
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
317
	);
318
319
	/**
320
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
321
	 */
322
	private $twitter_cards_conflicting_plugins = array(
323
		// 'twitter/twitter.php',                       // The official one handles this on its own.
324
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
325
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
326
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
327
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
328
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
329
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
330
		'twitter-cards/twitter-cards.php',           // Twitter Cards
331
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
332
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
333
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
334
	);
335
336
	/**
337
	 * Message to display in admin_notice
338
	 *
339
	 * @var string
340
	 */
341
	public $message = '';
342
343
	/**
344
	 * Error to display in admin_notice
345
	 *
346
	 * @var string
347
	 */
348
	public $error = '';
349
350
	/**
351
	 * Modules that need more privacy description.
352
	 *
353
	 * @var string
354
	 */
355
	public $privacy_checks = '';
356
357
	/**
358
	 * Stats to record once the page loads
359
	 *
360
	 * @var array
361
	 */
362
	public $stats = array();
363
364
	/**
365
	 * Jetpack_Sync object
366
	 */
367
	public $sync;
368
369
	/**
370
	 * Verified data for JSON authorization request
371
	 */
372
	public $json_api_authorization_request = array();
373
374
	/**
375
	 * @var Automattic\Jetpack\Connection\Manager
376
	 */
377
	protected $connection_manager;
378
379
	/**
380
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
381
	 */
382
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
383
384
	/**
385
	 * Holds the singleton instance of this class
386
	 *
387
	 * @since 2.3.3
388
	 * @var Jetpack
389
	 */
390
	static $instance = false;
391
392
	/**
393
	 * Singleton
394
	 *
395
	 * @static
396
	 */
397
	public static function init() {
398
		if ( ! self::$instance ) {
399
			self::$instance = new Jetpack();
400
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
401
		}
402
403
		return self::$instance;
404
	}
405
406
	/**
407
	 * Must never be called statically
408
	 */
409
	function plugin_upgrade() {
410
		if ( self::is_active() ) {
411
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
412
			if ( JETPACK__VERSION != $version ) {
413
				// Prevent multiple upgrades at once - only a single process should trigger
414
				// an upgrade to avoid stampedes
415
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
416
					return;
417
				}
418
419
				// Set a short lock to prevent multiple instances of the upgrade
420
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
421
422
				// check which active modules actually exist and remove others from active_modules list
423
				$unfiltered_modules = self::get_active_modules();
424
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
425
				if ( array_diff( $unfiltered_modules, $modules ) ) {
426
					self::update_active_modules( $modules );
427
				}
428
429
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
430
431
				// Upgrade to 4.3.0
432
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
433
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
434
				}
435
436
				// Make sure Markdown for posts gets turned back on
437
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
438
					update_option( 'wpcom_publish_posts_with_markdown', true );
439
				}
440
441
				if ( did_action( 'wp_loaded' ) ) {
442
					self::upgrade_on_load();
443
				} else {
444
					add_action(
445
						'wp_loaded',
446
						array( __CLASS__, 'upgrade_on_load' )
447
					);
448
				}
449
			}
450
		}
451
	}
452
453
	/**
454
	 * Runs upgrade routines that need to have modules loaded.
455
	 */
456
	static function upgrade_on_load() {
457
458
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
459
		// This can happen in case Jetpack has been just upgraded and is
460
		// being initialized late during the page load. In this case we wait
461
		// until the next proper admin page load with Jetpack active.
462
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
463
			delete_transient( self::$plugin_upgrade_lock_key );
464
465
			return;
466
		}
467
468
		self::maybe_set_version_option();
469
470
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
471
			Jetpack_Widget_Conditions::migrate_post_type_rules();
472
		}
473
474
		if (
475
			class_exists( 'Jetpack_Sitemap_Manager' )
476
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
477
		) {
478
			do_action( 'jetpack_sitemaps_purge_data' );
479
		}
480
481
		// Delete old stats cache
482
		delete_option( 'jetpack_restapi_stats_cache' );
483
484
		delete_transient( self::$plugin_upgrade_lock_key );
485
	}
486
487
	/**
488
	 * Saves all the currently active modules to options.
489
	 * Also fires Action hooks for each newly activated and deactivated module.
490
	 *
491
	 * @param $modules Array Array of active modules to be saved in options.
492
	 *
493
	 * @return $success bool true for success, false for failure.
0 ignored issues
show
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...
494
	 */
495
	static function update_active_modules( $modules ) {
496
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
497
		$active_modules       = self::get_active_modules();
498
		$new_active_modules   = array_diff( $modules, $current_modules );
499
		$new_inactive_modules = array_diff( $active_modules, $modules );
500
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
501
		$reindexed_modules    = array_values( $new_current_modules );
502
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
503
504
		foreach ( $new_active_modules as $module ) {
505
			/**
506
			 * Fires when a specific module is activated.
507
			 *
508
			 * @since 1.9.0
509
			 *
510
			 * @param string $module Module slug.
511
			 * @param boolean $success whether the module was activated. @since 4.2
512
			 */
513
			do_action( 'jetpack_activate_module', $module, $success );
514
			/**
515
			 * Fires when a module is activated.
516
			 * The dynamic part of the filter, $module, is the module slug.
517
			 *
518
			 * @since 1.9.0
519
			 *
520
			 * @param string $module Module slug.
521
			 */
522
			do_action( "jetpack_activate_module_$module", $module );
523
		}
524
525
		foreach ( $new_inactive_modules as $module ) {
526
			/**
527
			 * Fired after a module has been deactivated.
528
			 *
529
			 * @since 4.2.0
530
			 *
531
			 * @param string $module Module slug.
532
			 * @param boolean $success whether the module was deactivated.
533
			 */
534
			do_action( 'jetpack_deactivate_module', $module, $success );
535
			/**
536
			 * Fires when a module is deactivated.
537
			 * The dynamic part of the filter, $module, is the module slug.
538
			 *
539
			 * @since 1.9.0
540
			 *
541
			 * @param string $module Module slug.
542
			 */
543
			do_action( "jetpack_deactivate_module_$module", $module );
544
		}
545
546
		return $success;
547
	}
548
549
	static function delete_active_modules() {
550
		self::update_active_modules( array() );
551
	}
552
553
	/**
554
	 * Constructor.  Initializes WordPress hooks
555
	 */
556
	private function __construct() {
557
		/*
558
		 * Check for and alert any deprecated hooks
559
		 */
560
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
561
562
		add_action( 'plugins_loaded', array( $this, 'configure' ), 1 );
563
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
564
565
		add_filter(
566
			'jetpack_connection_secret_generator',
567
			function( $callable ) {
568
				return function() {
569
					return wp_generate_password( 32, false );
570
				};
571
			}
572
		);
573
574
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
575
576
		add_filter(
577
			'jetpack_signature_check_token',
578
			array( __CLASS__, 'verify_onboarding_token' ),
579
			10,
580
			3
581
		);
582
583
		/**
584
		 * Prepare Gutenberg Editor functionality
585
		 */
586
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
587
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
588
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
589
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
590
591
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
592
593
		// Unlink user before deleting the user from WP.com.
594
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
595
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
596
597
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
598
599
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
600
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
601
602
		add_action( 'admin_init', array( $this, 'admin_init' ) );
603
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
604
605
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
606
607
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
608
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
609
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
610
611
		// returns HTTPS support status
612
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
613
614
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
615
616
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
617
618
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
619
620
		/**
621
		 * These actions run checks to load additional files.
622
		 * They check for external files or plugins, so they need to run as late as possible.
623
		 */
624
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
625
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
626
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
627
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
628
629
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
630
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
631
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
632
633
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
634
635
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
636
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
637
638
		// A filter to control all just in time messages
639
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
640
641
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
642
643
		// Hide edit post link if mobile app.
644
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
645
			add_filter( 'edit_post_link', '__return_empty_string' );
646
		}
647
648
		// Update the Jetpack plan from API on heartbeats
649
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
650
651
		/**
652
		 * This is the hack to concatenate all css files into one.
653
		 * For description and reasoning see the implode_frontend_css method
654
		 *
655
		 * Super late priority so we catch all the registered styles
656
		 */
657
		if ( ! is_admin() ) {
658
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
659
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
660
		}
661
662
		/**
663
		 * These are sync actions that we need to keep track of for jitms
664
		 */
665
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
666
667
		// Actually push the stats on shutdown.
668
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
669
			add_action( 'shutdown', array( $this, 'push_stats' ) );
670
		}
671
672
		/*
673
		 * Load some scripts asynchronously.
674
		 */
675
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
676
677
		// Actions for Manager::authorize().
678
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
679
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
680
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
681
682
		// Filters for the Manager::get_token() urls and request body.
683
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
684
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
685
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
686
	}
687
688
	/**
689
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
690
	 * Config object.
691
	 */
692
	public function configure() {
693
		$config = new Config();
694
695
		foreach (
696
			array(
697
				'connection',
698
				'sync',
699
				'tracking',
700
				'tos',
701
			)
702
			as $feature
703
		) {
704
			$config->ensure( $feature );
705
		}
706
707
		if ( is_admin() ) {
708
			$config->ensure( 'jitm' );
709
		}
710
711
		$this->connection_manager = new Connection_Manager();
712
713
		/*
714
		 * Load things that should only be in Network Admin.
715
		 *
716
		 * For now blow away everything else until a more full
717
		 * understanding of what is needed at the network level is
718
		 * available
719
		 */
720
		if ( is_multisite() ) {
721
			$network = Jetpack_Network::init();
722
			$network->set_connection( $this->connection_manager );
723
		}
724
725
		if ( $this->connection_manager->is_active() ) {
726
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
727
728
			Jetpack_Heartbeat::init();
729
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
730
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
731
				Jetpack_Search_Performance_Logger::init();
732
			}
733
		}
734
735
		// Initialize remote file upload request handlers.
736
		$this->add_remote_request_handlers();
737
738
		/*
739
		 * Enable enhanced handling of previewing sites in Calypso
740
		 */
741
		if ( self::is_active() ) {
742
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
743
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
744
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
745
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
746
		}
747
748
		/*
749
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
750
		 * We should make sure to only do this for front end links.
751
		 */
752
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
753
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
754
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
755
756
			/*
757
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
758
			 * so they point moderation links on emails to Calypso.
759
			 */
760
			jetpack_require_lib( 'functions.wp-notify' );
761
		}
762
763
	}
764
765
	/**
766
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
767
	 * initialization code.
768
	 *
769
	 * @action plugins_loaded
770
	 */
771
	public function late_initialization() {
772
		add_action( 'plugins_loaded', array( 'Jetpack', 'plugin_textdomain' ), 99 );
773
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
774
775
		Partner::init();
776
777
		/**
778
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
779
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
780
		 *
781
		 * @since 8.1.0
782
		 *
783
		 * @param Jetpack $jetpack the main plugin class object.
784
		 */
785
		do_action( 'jetpack_loaded', $this );
786
787
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
788
	}
789
790
	/**
791
	 * Sets up the XMLRPC request handlers.
792
	 *
793
	 * @deprecated since 7.7.0
794
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
795
	 *
796
	 * @param Array                 $request_params Incoming request parameters.
797
	 * @param Boolean               $is_active      Whether the connection is currently active.
798
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
799
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
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...
800
	 */
801
	public function setup_xmlrpc_handlers(
802
		$request_params,
803
		$is_active,
804
		$is_signed,
805
		Jetpack_XMLRPC_Server $xmlrpc_server = null
806
	) {
807
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
808
		return $this->connection_manager->setup_xmlrpc_handlers(
809
			$request_params,
810
			$is_active,
811
			$is_signed,
812
			$xmlrpc_server
813
		);
814
	}
815
816
	/**
817
	 * Initialize REST API registration connector.
818
	 *
819
	 * @deprecated since 7.7.0
820
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
821
	 */
822
	public function initialize_rest_api_registration_connector() {
823
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
824
		$this->connection_manager->initialize_rest_api_registration_connector();
825
	}
826
827
	/**
828
	 * This is ported over from the manage module, which has been deprecated and baked in here.
829
	 *
830
	 * @param $domains
831
	 */
832
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
833
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
834
	}
835
836
	/**
837
	 * Return $domains, with 'wordpress.com' appended.
838
	 * This is ported over from the manage module, which has been deprecated and baked in here.
839
	 *
840
	 * @param $domains
841
	 * @return array
842
	 */
843
	function allow_wpcom_domain( $domains ) {
844
		if ( empty( $domains ) ) {
845
			$domains = array();
846
		}
847
		$domains[] = 'wordpress.com';
848
		return array_unique( $domains );
849
	}
850
851
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
852
		$post = get_post( $post_id );
853
854
		if ( empty( $post ) ) {
855
			return $default_url;
856
		}
857
858
		$post_type = $post->post_type;
859
860
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
861
		// https://en.support.wordpress.com/custom-post-types/
862
		$allowed_post_types = array(
863
			'post'                => 'post',
864
			'page'                => 'page',
865
			'jetpack-portfolio'   => 'edit/jetpack-portfolio',
866
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
867
		);
868
869
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
870
			return $default_url;
871
		}
872
873
		$path_prefix = $allowed_post_types[ $post_type ];
874
875
		$site_slug = self::build_raw_urls( get_home_url() );
876
877
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
878
	}
879
880
	function point_edit_comment_links_to_calypso( $url ) {
881
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
882
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
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...
883
		return esc_url(
884
			sprintf(
885
				'https://wordpress.com/comment/%s/%d',
886
				self::build_raw_urls( get_home_url() ),
887
				$query_args['amp;c']
888
			)
889
		);
890
	}
891
892
	function jetpack_track_last_sync_callback( $params ) {
893
		/**
894
		 * Filter to turn off jitm caching
895
		 *
896
		 * @since 5.4.0
897
		 *
898
		 * @param bool false Whether to cache just in time messages
899
		 */
900
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
901
			return $params;
902
		}
903
904
		if ( is_array( $params ) && isset( $params[0] ) ) {
905
			$option = $params[0];
906
			if ( 'active_plugins' === $option ) {
907
				// use the cache if we can, but not terribly important if it gets evicted
908
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
909
			}
910
		}
911
912
		return $params;
913
	}
914
915
	function jetpack_connection_banner_callback() {
916
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
917
918
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
919
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
920
			wp_send_json_success();
921
		}
922
923
		wp_die();
924
	}
925
926
	/**
927
	 * Removes all XML-RPC methods that are not `jetpack.*`.
928
	 * Only used in our alternate XML-RPC endpoint, where we want to
929
	 * ensure that Core and other plugins' methods are not exposed.
930
	 *
931
	 * @deprecated since 7.7.0
932
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
933
	 *
934
	 * @param array $methods A list of registered WordPress XMLRPC methods.
935
	 * @return array Filtered $methods
936
	 */
937
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
938
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
939
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
940
	}
941
942
	/**
943
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
944
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
945
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
946
	 * which is accessible via a different URI. Most of the below is copied directly
947
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
948
	 *
949
	 * @deprecated since 7.7.0
950
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
951
	 */
952
	public function alternate_xmlrpc() {
953
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
954
		$this->connection_manager->alternate_xmlrpc();
955
	}
956
957
	/**
958
	 * The callback for the JITM ajax requests.
959
	 *
960
	 * @deprecated since 7.9.0
961
	 */
962
	function jetpack_jitm_ajax_callback() {
963
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
964
	}
965
966
	/**
967
	 * If there are any stats that need to be pushed, but haven't been, push them now.
968
	 */
969
	function push_stats() {
970
		if ( ! empty( $this->stats ) ) {
971
			$this->do_stats( 'server_side' );
972
		}
973
	}
974
975
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
976
		$is_development_mode = ( new Status() )->is_development_mode();
977
		switch ( $cap ) {
978
			case 'jetpack_connect':
979
			case 'jetpack_reconnect':
980
				if ( $is_development_mode ) {
981
					$caps = array( 'do_not_allow' );
982
					break;
983
				}
984
				/**
985
				 * Pass through. If it's not development mode, these should match disconnect.
986
				 * Let users disconnect if it's development mode, just in case things glitch.
987
				 */
988
			case 'jetpack_disconnect':
989
				/**
990
				 * In multisite, can individual site admins manage their own connection?
991
				 *
992
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
993
				 */
994
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
995
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
996
						/**
997
						 * We need to update the option name -- it's terribly unclear which
998
						 * direction the override goes.
999
						 *
1000
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
1001
						 */
1002
						$caps = array( 'do_not_allow' );
1003
						break;
1004
					}
1005
				}
1006
1007
				$caps = array( 'manage_options' );
1008
				break;
1009
			case 'jetpack_manage_modules':
1010
			case 'jetpack_activate_modules':
1011
			case 'jetpack_deactivate_modules':
1012
				$caps = array( 'manage_options' );
1013
				break;
1014
			case 'jetpack_configure_modules':
1015
				$caps = array( 'manage_options' );
1016
				break;
1017
			case 'jetpack_manage_autoupdates':
1018
				$caps = array(
1019
					'manage_options',
1020
					'update_plugins',
1021
				);
1022
				break;
1023
			case 'jetpack_network_admin_page':
1024
			case 'jetpack_network_settings_page':
1025
				$caps = array( 'manage_network_plugins' );
1026
				break;
1027
			case 'jetpack_network_sites_page':
1028
				$caps = array( 'manage_sites' );
1029
				break;
1030
			case 'jetpack_admin_page':
1031
				if ( $is_development_mode ) {
1032
					$caps = array( 'manage_options' );
1033
					break;
1034
				} else {
1035
					$caps = array( 'read' );
1036
				}
1037
				break;
1038
			case 'jetpack_connect_user':
1039
				if ( $is_development_mode ) {
1040
					$caps = array( 'do_not_allow' );
1041
					break;
1042
				}
1043
				$caps = array( 'read' );
1044
				break;
1045
		}
1046
		return $caps;
1047
	}
1048
1049
	/**
1050
	 * Require a Jetpack authentication.
1051
	 *
1052
	 * @deprecated since 7.7.0
1053
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1054
	 */
1055
	public function require_jetpack_authentication() {
1056
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1057
		$this->connection_manager->require_jetpack_authentication();
1058
	}
1059
1060
	/**
1061
	 * Load language files
1062
	 *
1063
	 * @action plugins_loaded
1064
	 */
1065
	public static function plugin_textdomain() {
1066
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1067
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1068
	}
1069
1070
	/**
1071
	 * Register assets for use in various modules and the Jetpack admin page.
1072
	 *
1073
	 * @uses wp_script_is, wp_register_script, plugins_url
1074
	 * @action wp_loaded
1075
	 * @return null
1076
	 */
1077
	public function register_assets() {
1078
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1079
			wp_register_script(
1080
				'spin',
1081
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1082
				false,
1083
				'1.3'
1084
			);
1085
		}
1086
1087 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1088
			wp_register_script(
1089
				'jquery.spin',
1090
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1091
				array( 'jquery', 'spin' ),
1092
				'1.3'
1093
			);
1094
		}
1095
1096 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1097
			wp_register_script(
1098
				'jetpack-gallery-settings',
1099
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1100
				array( 'media-views' ),
1101
				'20121225'
1102
			);
1103
		}
1104
1105 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1106
			wp_register_script(
1107
				'jetpack-twitter-timeline',
1108
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1109
				array( 'jquery' ),
1110
				'4.0.0',
1111
				true
1112
			);
1113
		}
1114
1115
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1116
			wp_register_script(
1117
				'jetpack-facebook-embed',
1118
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1119
				array( 'jquery' ),
1120
				null,
1121
				true
1122
			);
1123
1124
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1125
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1126
			if ( ! is_numeric( $fb_app_id ) ) {
1127
				$fb_app_id = '';
1128
			}
1129
			wp_localize_script(
1130
				'jetpack-facebook-embed',
1131
				'jpfbembed',
1132
				array(
1133
					'appid'  => $fb_app_id,
1134
					'locale' => $this->get_locale(),
1135
				)
1136
			);
1137
		}
1138
1139
		/**
1140
		 * As jetpack_register_genericons is by default fired off a hook,
1141
		 * the hook may have already fired by this point.
1142
		 * So, let's just trigger it manually.
1143
		 */
1144
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1145
		jetpack_register_genericons();
1146
1147
		/**
1148
		 * Register the social logos
1149
		 */
1150
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1151
		jetpack_register_social_logos();
1152
1153 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1154
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1155
		}
1156
	}
1157
1158
	/**
1159
	 * Guess locale from language code.
1160
	 *
1161
	 * @param string $lang Language code.
1162
	 * @return string|bool
1163
	 */
1164 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1165
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1166
			return 'en_US';
1167
		}
1168
1169
		if ( ! class_exists( 'GP_Locales' ) ) {
1170
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1171
				return false;
1172
			}
1173
1174
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1175
		}
1176
1177
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1178
			// WP.com: get_locale() returns 'it'
1179
			$locale = GP_Locales::by_slug( $lang );
1180
		} else {
1181
			// Jetpack: get_locale() returns 'it_IT';
1182
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1183
		}
1184
1185
		if ( ! $locale ) {
1186
			return false;
1187
		}
1188
1189
		if ( empty( $locale->facebook_locale ) ) {
1190
			if ( empty( $locale->wp_locale ) ) {
1191
				return false;
1192
			} else {
1193
				// Facebook SDK is smart enough to fall back to en_US if a
1194
				// locale isn't supported. Since supported Facebook locales
1195
				// can fall out of sync, we'll attempt to use the known
1196
				// wp_locale value and rely on said fallback.
1197
				return $locale->wp_locale;
1198
			}
1199
		}
1200
1201
		return $locale->facebook_locale;
1202
	}
1203
1204
	/**
1205
	 * Get the locale.
1206
	 *
1207
	 * @return string|bool
1208
	 */
1209
	function get_locale() {
1210
		$locale = $this->guess_locale_from_lang( get_locale() );
1211
1212
		if ( ! $locale ) {
1213
			$locale = 'en_US';
1214
		}
1215
1216
		return $locale;
1217
	}
1218
1219
	/**
1220
	 * Return the network_site_url so that .com knows what network this site is a part of.
1221
	 *
1222
	 * @param  bool $option
1223
	 * @return string
1224
	 */
1225
	public function jetpack_main_network_site_option( $option ) {
1226
		return network_site_url();
1227
	}
1228
	/**
1229
	 * Network Name.
1230
	 */
1231
	static function network_name( $option = null ) {
1232
		global $current_site;
1233
		return $current_site->site_name;
1234
	}
1235
	/**
1236
	 * Does the network allow new user and site registrations.
1237
	 *
1238
	 * @return string
1239
	 */
1240
	static function network_allow_new_registrations( $option = null ) {
1241
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1242
	}
1243
	/**
1244
	 * Does the network allow admins to add new users.
1245
	 *
1246
	 * @return boolian
1247
	 */
1248
	static function network_add_new_users( $option = null ) {
1249
		return (bool) get_site_option( 'add_new_users' );
1250
	}
1251
	/**
1252
	 * File upload psace left per site in MB.
1253
	 *  -1 means NO LIMIT.
1254
	 *
1255
	 * @return number
1256
	 */
1257
	static function network_site_upload_space( $option = null ) {
1258
		// value in MB
1259
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1260
	}
1261
1262
	/**
1263
	 * Network allowed file types.
1264
	 *
1265
	 * @return string
1266
	 */
1267
	static function network_upload_file_types( $option = null ) {
1268
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1269
	}
1270
1271
	/**
1272
	 * Maximum file upload size set by the network.
1273
	 *
1274
	 * @return number
1275
	 */
1276
	static function network_max_upload_file_size( $option = null ) {
1277
		// value in KB
1278
		return get_site_option( 'fileupload_maxk', 300 );
1279
	}
1280
1281
	/**
1282
	 * Lets us know if a site allows admins to manage the network.
1283
	 *
1284
	 * @return array
1285
	 */
1286
	static function network_enable_administration_menus( $option = null ) {
1287
		return get_site_option( 'menu_items' );
1288
	}
1289
1290
	/**
1291
	 * If a user has been promoted to or demoted from admin, we need to clear the
1292
	 * jetpack_other_linked_admins transient.
1293
	 *
1294
	 * @since 4.3.2
1295
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1296
	 *
1297
	 * @param int    $user_id   The user ID whose role changed.
1298
	 * @param string $role      The new role.
1299
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
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...
1300
	 */
1301
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1302
		if ( 'administrator' == $role
1303
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1304
			|| is_null( $old_roles )
1305
		) {
1306
			delete_transient( 'jetpack_other_linked_admins' );
1307
		}
1308
	}
1309
1310
	/**
1311
	 * Checks to see if there are any other users available to become primary
1312
	 * Users must both:
1313
	 * - Be linked to wpcom
1314
	 * - Be an admin
1315
	 *
1316
	 * @return mixed False if no other users are linked, Int if there are.
1317
	 */
1318
	static function get_other_linked_admins() {
1319
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1320
1321
		if ( false === $other_linked_users ) {
1322
			$admins = get_users( array( 'role' => 'administrator' ) );
1323
			if ( count( $admins ) > 1 ) {
1324
				$available = array();
1325
				foreach ( $admins as $admin ) {
1326
					if ( self::is_user_connected( $admin->ID ) ) {
1327
						$available[] = $admin->ID;
1328
					}
1329
				}
1330
1331
				$count_connected_admins = count( $available );
1332
				if ( count( $available ) > 1 ) {
1333
					$other_linked_users = $count_connected_admins;
1334
				} else {
1335
					$other_linked_users = 0;
1336
				}
1337
			} else {
1338
				$other_linked_users = 0;
1339
			}
1340
1341
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1342
		}
1343
1344
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1345
	}
1346
1347
	/**
1348
	 * Return whether we are dealing with a multi network setup or not.
1349
	 * The reason we are type casting this is because we want to avoid the situation where
1350
	 * the result is false since when is_main_network_option return false it cases
1351
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1352
	 * database which could be set to anything as opposed to what this function returns.
1353
	 *
1354
	 * @param  bool $option
1355
	 *
1356
	 * @return boolean
1357
	 */
1358
	public function is_main_network_option( $option ) {
1359
		// return '1' or ''
1360
		return (string) (bool) self::is_multi_network();
1361
	}
1362
1363
	/**
1364
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1365
	 *
1366
	 * @param  string $option
1367
	 * @return boolean
1368
	 */
1369
	public function is_multisite( $option ) {
1370
		return (string) (bool) is_multisite();
1371
	}
1372
1373
	/**
1374
	 * Implemented since there is no core is multi network function
1375
	 * Right now there is no way to tell if we which network is the dominant network on the system
1376
	 *
1377
	 * @since  3.3
1378
	 * @return boolean
1379
	 */
1380 View Code Duplication
	public static function is_multi_network() {
1381
		global  $wpdb;
1382
1383
		// if we don't have a multi site setup no need to do any more
1384
		if ( ! is_multisite() ) {
1385
			return false;
1386
		}
1387
1388
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1389
		if ( $num_sites > 1 ) {
1390
			return true;
1391
		} else {
1392
			return false;
1393
		}
1394
	}
1395
1396
	/**
1397
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1398
	 *
1399
	 * @return null
1400
	 */
1401
	function update_jetpack_main_network_site_option() {
1402
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1403
	}
1404
	/**
1405
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1406
	 */
1407
	function update_jetpack_network_settings() {
1408
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1409
		// Only sync this info for the main network site.
1410
	}
1411
1412
	/**
1413
	 * Get back if the current site is single user site.
1414
	 *
1415
	 * @return bool
1416
	 */
1417 View Code Duplication
	public static function is_single_user_site() {
1418
		global $wpdb;
1419
1420
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1421
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1422
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1423
		}
1424
		return 1 === (int) $some_users;
1425
	}
1426
1427
	/**
1428
	 * Returns true if the site has file write access false otherwise.
1429
	 *
1430
	 * @return string ( '1' | '0' )
1431
	 **/
1432
	public static function file_system_write_access() {
1433
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1434
			require_once ABSPATH . 'wp-admin/includes/file.php';
1435
		}
1436
1437
		require_once ABSPATH . 'wp-admin/includes/template.php';
1438
1439
		$filesystem_method = get_filesystem_method();
1440
		if ( $filesystem_method === 'direct' ) {
1441
			return 1;
1442
		}
1443
1444
		ob_start();
1445
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1446
		ob_end_clean();
1447
		if ( $filesystem_credentials_are_stored ) {
1448
			return 1;
1449
		}
1450
		return 0;
1451
	}
1452
1453
	/**
1454
	 * Finds out if a site is using a version control system.
1455
	 *
1456
	 * @return string ( '1' | '0' )
1457
	 **/
1458
	public static function is_version_controlled() {
1459
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1460
		return (string) (int) Functions::is_version_controlled();
1461
	}
1462
1463
	/**
1464
	 * Determines whether the current theme supports featured images or not.
1465
	 *
1466
	 * @return string ( '1' | '0' )
1467
	 */
1468
	public static function featured_images_enabled() {
1469
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1470
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1471
	}
1472
1473
	/**
1474
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1475
	 *
1476
	 * @deprecated 4.7 use get_avatar_url instead.
1477
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1478
	 * @param int               $size Size of the avatar image
1479
	 * @param string            $default URL to a default image to use if no avatar is available
1480
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1481
	 *
1482
	 * @return array
1483
	 */
1484
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1485
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1486
		return get_avatar_url(
1487
			$id_or_email,
1488
			array(
1489
				'size'          => $size,
1490
				'default'       => $default,
1491
				'force_default' => $force_display,
1492
			)
1493
		);
1494
	}
1495
1496
	/**
1497
	 * jetpack_updates is saved in the following schema:
1498
	 *
1499
	 * array (
1500
	 *      'plugins'                       => (int) Number of plugin updates available.
1501
	 *      'themes'                        => (int) Number of theme updates available.
1502
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1503
	 *      'translations'                  => (int) Number of translation updates available.
1504
	 *      'total'                         => (int) Total of all available updates.
1505
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1506
	 * )
1507
	 *
1508
	 * @return array
1509
	 */
1510
	public static function get_updates() {
1511
		$update_data = wp_get_update_data();
1512
1513
		// Stores the individual update counts as well as the total count.
1514
		if ( isset( $update_data['counts'] ) ) {
1515
			$updates = $update_data['counts'];
1516
		}
1517
1518
		// If we need to update WordPress core, let's find the latest version number.
1519 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1520
			$cur = get_preferred_from_update_core();
1521
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1522
				$updates['wp_update_version'] = $cur->current;
1523
			}
1524
		}
1525
		return isset( $updates ) ? $updates : array();
1526
	}
1527
1528
	public static function get_update_details() {
1529
		$update_details = array(
1530
			'update_core'    => get_site_transient( 'update_core' ),
1531
			'update_plugins' => get_site_transient( 'update_plugins' ),
1532
			'update_themes'  => get_site_transient( 'update_themes' ),
1533
		);
1534
		return $update_details;
1535
	}
1536
1537
	public static function refresh_update_data() {
1538
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1539
1540
	}
1541
1542
	public static function refresh_theme_data() {
1543
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1544
	}
1545
1546
	/**
1547
	 * Is Jetpack active?
1548
	 */
1549
	public static function is_active() {
1550
		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...
1551
	}
1552
1553
	/**
1554
	 * Make an API call to WordPress.com for plan status
1555
	 *
1556
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1557
	 *
1558
	 * @return bool True if plan is updated, false if no update
1559
	 */
1560
	public static function refresh_active_plan_from_wpcom() {
1561
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1562
		return Jetpack_Plan::refresh_from_wpcom();
1563
	}
1564
1565
	/**
1566
	 * Get the plan that this Jetpack site is currently using
1567
	 *
1568
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1569
	 * @return array Active Jetpack plan details.
1570
	 */
1571
	public static function get_active_plan() {
1572
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1573
		return Jetpack_Plan::get();
1574
	}
1575
1576
	/**
1577
	 * Determine whether the active plan supports a particular feature
1578
	 *
1579
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1580
	 * @return bool True if plan supports feature, false if not.
1581
	 */
1582
	public static function active_plan_supports( $feature ) {
1583
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1584
		return Jetpack_Plan::supports( $feature );
1585
	}
1586
1587
	/**
1588
	 * Deprecated: Is Jetpack in development (offline) mode?
1589
	 *
1590
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1591
	 * and themes still use it, and we do not want to flood them with notices.
1592
	 *
1593
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1594
	 *
1595
	 * @deprecated since 8.0.
1596
	 */
1597
	public static function is_development_mode() {
1598
		return ( new Status() )->is_development_mode();
1599
	}
1600
1601
	/**
1602
	 * Whether the site is currently onboarding or not.
1603
	 * A site is considered as being onboarded if it currently has an onboarding token.
1604
	 *
1605
	 * @since 5.8
1606
	 *
1607
	 * @access public
1608
	 * @static
1609
	 *
1610
	 * @return bool True if the site is currently onboarding, false otherwise
1611
	 */
1612
	public static function is_onboarding() {
1613
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1614
	}
1615
1616
	/**
1617
	 * Determines reason for Jetpack development mode.
1618
	 */
1619
	public static function development_mode_trigger_text() {
1620
		if ( ! ( new Status() )->is_development_mode() ) {
1621
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1622
		}
1623
1624
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1625
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1626
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1627
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1628
		} else {
1629
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1630
		}
1631
1632
		return $notice;
1633
1634
	}
1635
	/**
1636
	 * Get Jetpack development mode notice text and notice class.
1637
	 *
1638
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1639
	 */
1640
	public static function show_development_mode_notice() {
1641 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1642
			$notice = sprintf(
1643
				/* translators: %s is a URL */
1644
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1645
				'https://jetpack.com/support/development-mode/'
1646
			);
1647
1648
			$notice .= ' ' . self::development_mode_trigger_text();
1649
1650
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1651
		}
1652
1653
		// Throw up a notice if using a development version and as for feedback.
1654
		if ( self::is_development_version() ) {
1655
			/* translators: %s is a URL */
1656
			$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/' );
1657
1658
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1659
		}
1660
		// Throw up a notice if using staging mode
1661
		if ( ( new Status() )->is_staging_site() ) {
1662
			/* translators: %s is a URL */
1663
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1664
1665
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1666
		}
1667
	}
1668
1669
	/**
1670
	 * Whether Jetpack's version maps to a public release, or a development version.
1671
	 */
1672
	public static function is_development_version() {
1673
		/**
1674
		 * Allows filtering whether this is a development version of Jetpack.
1675
		 *
1676
		 * This filter is especially useful for tests.
1677
		 *
1678
		 * @since 4.3.0
1679
		 *
1680
		 * @param bool $development_version Is this a develoment version of Jetpack?
1681
		 */
1682
		return (bool) apply_filters(
1683
			'jetpack_development_version',
1684
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1685
		);
1686
	}
1687
1688
	/**
1689
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1690
	 */
1691
	public static function is_user_connected( $user_id = false ) {
1692
		return self::connection()->is_user_connected( $user_id );
1693
	}
1694
1695
	/**
1696
	 * Get the wpcom user data of the current|specified connected user.
1697
	 */
1698 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1699
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1700
		if ( ! $user_id ) {
1701
			$user_id = get_current_user_id();
1702
		}
1703
1704
		$transient_key = "jetpack_connected_user_data_$user_id";
1705
1706
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1707
			return $cached_user_data;
1708
		}
1709
1710
		$xml = new Jetpack_IXR_Client(
1711
			array(
1712
				'user_id' => $user_id,
1713
			)
1714
		);
1715
		$xml->query( 'wpcom.getUser' );
1716
		if ( ! $xml->isError() ) {
1717
			$user_data = $xml->getResponse();
1718
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1719
			return $user_data;
1720
		}
1721
1722
		return false;
1723
	}
1724
1725
	/**
1726
	 * Get the wpcom email of the current|specified connected user.
1727
	 */
1728 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1729
		if ( ! $user_id ) {
1730
			$user_id = get_current_user_id();
1731
		}
1732
1733
		$xml = new Jetpack_IXR_Client(
1734
			array(
1735
				'user_id' => $user_id,
1736
			)
1737
		);
1738
		$xml->query( 'wpcom.getUserEmail' );
1739
		if ( ! $xml->isError() ) {
1740
			return $xml->getResponse();
1741
		}
1742
		return false;
1743
	}
1744
1745
	/**
1746
	 * Get the wpcom email of the master user.
1747
	 */
1748
	public static function get_master_user_email() {
1749
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1750
		if ( $master_user_id ) {
1751
			return self::get_connected_user_email( $master_user_id );
1752
		}
1753
		return '';
1754
	}
1755
1756
	/**
1757
	 * Whether the current user is the connection owner.
1758
	 *
1759
	 * @deprecated since 7.7
1760
	 *
1761
	 * @return bool Whether the current user is the connection owner.
1762
	 */
1763
	public function current_user_is_connection_owner() {
1764
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1765
		return self::connection()->is_connection_owner();
1766
	}
1767
1768
	/**
1769
	 * Gets current user IP address.
1770
	 *
1771
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1772
	 *
1773
	 * @return string                  Current user IP address.
1774
	 */
1775
	public static function current_user_ip( $check_all_headers = false ) {
1776
		if ( $check_all_headers ) {
1777
			foreach ( array(
1778
				'HTTP_CF_CONNECTING_IP',
1779
				'HTTP_CLIENT_IP',
1780
				'HTTP_X_FORWARDED_FOR',
1781
				'HTTP_X_FORWARDED',
1782
				'HTTP_X_CLUSTER_CLIENT_IP',
1783
				'HTTP_FORWARDED_FOR',
1784
				'HTTP_FORWARDED',
1785
				'HTTP_VIA',
1786
			) as $key ) {
1787
				if ( ! empty( $_SERVER[ $key ] ) ) {
1788
					return $_SERVER[ $key ];
1789
				}
1790
			}
1791
		}
1792
1793
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1794
	}
1795
1796
	/**
1797
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1798
	 */
1799
	function extra_oembed_providers() {
1800
		// Cloudup: https://dev.cloudup.com/#oembed
1801
		wp_oembed_add_provider( 'https://cloudup.com/*', 'https://cloudup.com/oembed' );
1802
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1803
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1804
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1805
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1806
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1807
		wp_oembed_add_provider( 'https://song.link/*', 'https://song.link/oembed', false );
1808
	}
1809
1810
	/**
1811
	 * Synchronize connected user role changes
1812
	 */
1813
	function user_role_change( $user_id ) {
1814
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1815
		Users::user_role_change( $user_id );
1816
	}
1817
1818
	/**
1819
	 * Loads the currently active modules.
1820
	 */
1821
	public static function load_modules() {
1822
		$is_development_mode = ( new Status() )->is_development_mode();
1823
		if (
1824
			! self::is_active()
1825
			&& ! $is_development_mode
1826
			&& ! self::is_onboarding()
1827
			&& (
1828
				! is_multisite()
1829
				|| ! get_site_option( 'jetpack_protect_active' )
1830
			)
1831
		) {
1832
			return;
1833
		}
1834
1835
		$version = Jetpack_Options::get_option( 'version' );
1836 View Code Duplication
		if ( ! $version ) {
1837
			$version = $old_version = JETPACK__VERSION . ':' . time();
1838
			/** This action is documented in class.jetpack.php */
1839
			do_action( 'updating_jetpack_version', $version, false );
1840
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1841
		}
1842
		list( $version ) = explode( ':', $version );
1843
1844
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1845
1846
		$modules_data = array();
1847
1848
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1849
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1850
			$updated_modules = array();
1851
			foreach ( $modules as $module ) {
1852
				$modules_data[ $module ] = self::get_module( $module );
1853
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1854
					continue;
1855
				}
1856
1857
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1858
					continue;
1859
				}
1860
1861
				$updated_modules[] = $module;
1862
			}
1863
1864
			$modules = array_diff( $modules, $updated_modules );
1865
		}
1866
1867
		foreach ( $modules as $index => $module ) {
1868
			// If we're in dev mode, disable modules requiring a connection
1869
			if ( $is_development_mode ) {
1870
				// Prime the pump if we need to
1871
				if ( empty( $modules_data[ $module ] ) ) {
1872
					$modules_data[ $module ] = self::get_module( $module );
1873
				}
1874
				// If the module requires a connection, but we're in local mode, don't include it.
1875
				if ( $modules_data[ $module ]['requires_connection'] ) {
1876
					continue;
1877
				}
1878
			}
1879
1880
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1881
				continue;
1882
			}
1883
1884
			if ( ! include_once self::get_module_path( $module ) ) {
1885
				unset( $modules[ $index ] );
1886
				self::update_active_modules( array_values( $modules ) );
1887
				continue;
1888
			}
1889
1890
			/**
1891
			 * Fires when a specific module is loaded.
1892
			 * The dynamic part of the hook, $module, is the module slug.
1893
			 *
1894
			 * @since 1.1.0
1895
			 */
1896
			do_action( 'jetpack_module_loaded_' . $module );
1897
		}
1898
1899
		/**
1900
		 * Fires when all the modules are loaded.
1901
		 *
1902
		 * @since 1.1.0
1903
		 */
1904
		do_action( 'jetpack_modules_loaded' );
1905
1906
		// 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.
1907
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1908
	}
1909
1910
	/**
1911
	 * Check if Jetpack's REST API compat file should be included
1912
	 *
1913
	 * @action plugins_loaded
1914
	 * @return null
1915
	 */
1916
	public function check_rest_api_compat() {
1917
		/**
1918
		 * Filters the list of REST API compat files to be included.
1919
		 *
1920
		 * @since 2.2.5
1921
		 *
1922
		 * @param array $args Array of REST API compat files to include.
1923
		 */
1924
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1925
1926
		if ( function_exists( 'bbpress' ) ) {
1927
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1928
		}
1929
1930
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1931
			require_once $_jetpack_rest_api_compat_include;
1932
		}
1933
	}
1934
1935
	/**
1936
	 * Gets all plugins currently active in values, regardless of whether they're
1937
	 * traditionally activated or network activated.
1938
	 *
1939
	 * @todo Store the result in core's object cache maybe?
1940
	 */
1941
	public static function get_active_plugins() {
1942
		$active_plugins = (array) get_option( 'active_plugins', array() );
1943
1944
		if ( is_multisite() ) {
1945
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1946
			// whereas active_plugins stores them in the values.
1947
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1948
			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...
1949
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1950
			}
1951
		}
1952
1953
		sort( $active_plugins );
1954
1955
		return array_unique( $active_plugins );
1956
	}
1957
1958
	/**
1959
	 * Gets and parses additional plugin data to send with the heartbeat data
1960
	 *
1961
	 * @since 3.8.1
1962
	 *
1963
	 * @return array Array of plugin data
1964
	 */
1965
	public static function get_parsed_plugin_data() {
1966
		if ( ! function_exists( 'get_plugins' ) ) {
1967
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
1968
		}
1969
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1970
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1971
		$active_plugins = self::get_active_plugins();
1972
1973
		$plugins = array();
1974
		foreach ( $all_plugins as $path => $plugin_data ) {
1975
			$plugins[ $path ] = array(
1976
				'is_active' => in_array( $path, $active_plugins ),
1977
				'file'      => $path,
1978
				'name'      => $plugin_data['Name'],
1979
				'version'   => $plugin_data['Version'],
1980
				'author'    => $plugin_data['Author'],
1981
			);
1982
		}
1983
1984
		return $plugins;
1985
	}
1986
1987
	/**
1988
	 * Gets and parses theme data to send with the heartbeat data
1989
	 *
1990
	 * @since 3.8.1
1991
	 *
1992
	 * @return array Array of theme data
1993
	 */
1994
	public static function get_parsed_theme_data() {
1995
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
1996
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1997
1998
		$themes = array();
1999
		foreach ( $all_themes as $slug => $theme_data ) {
2000
			$theme_headers = array();
2001
			foreach ( $header_keys as $header_key ) {
2002
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2003
			}
2004
2005
			$themes[ $slug ] = array(
2006
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2007
				'slug'            => $slug,
2008
				'theme_root'      => $theme_data->get_theme_root_uri(),
2009
				'parent'          => $theme_data->parent(),
2010
				'headers'         => $theme_headers,
2011
			);
2012
		}
2013
2014
		return $themes;
2015
	}
2016
2017
	/**
2018
	 * Checks whether a specific plugin is active.
2019
	 *
2020
	 * We don't want to store these in a static variable, in case
2021
	 * there are switch_to_blog() calls involved.
2022
	 */
2023
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2024
		return in_array( $plugin, self::get_active_plugins() );
2025
	}
2026
2027
	/**
2028
	 * Check if Jetpack's Open Graph tags should be used.
2029
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2030
	 *
2031
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2032
	 * @action plugins_loaded
2033
	 * @return null
2034
	 */
2035
	public function check_open_graph() {
2036
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2037
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2038
		}
2039
2040
		$active_plugins = self::get_active_plugins();
2041
2042
		if ( ! empty( $active_plugins ) ) {
2043
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2044
				if ( in_array( $plugin, $active_plugins ) ) {
2045
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2046
					break;
2047
				}
2048
			}
2049
		}
2050
2051
		/**
2052
		 * Allow the addition of Open Graph Meta Tags to all pages.
2053
		 *
2054
		 * @since 2.0.3
2055
		 *
2056
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2057
		 */
2058
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2059
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2060
		}
2061
	}
2062
2063
	/**
2064
	 * Check if Jetpack's Twitter tags should be used.
2065
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2066
	 *
2067
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2068
	 * @action plugins_loaded
2069
	 * @return null
2070
	 */
2071
	public function check_twitter_tags() {
2072
2073
		$active_plugins = self::get_active_plugins();
2074
2075
		if ( ! empty( $active_plugins ) ) {
2076
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2077
				if ( in_array( $plugin, $active_plugins ) ) {
2078
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2079
					break;
2080
				}
2081
			}
2082
		}
2083
2084
		/**
2085
		 * Allow Twitter Card Meta tags to be disabled.
2086
		 *
2087
		 * @since 2.6.0
2088
		 *
2089
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2090
		 */
2091
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2092
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2093
		}
2094
	}
2095
2096
	/**
2097
	 * Allows plugins to submit security reports.
2098
	 *
2099
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2100
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2101
	 * @param array  $args         See definitions above
2102
	 */
2103
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2104
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2105
	}
2106
2107
	/* Jetpack Options API */
2108
2109
	public static function get_option_names( $type = 'compact' ) {
2110
		return Jetpack_Options::get_option_names( $type );
2111
	}
2112
2113
	/**
2114
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2115
	 *
2116
	 * @param string $name    Option name
2117
	 * @param mixed  $default (optional)
2118
	 */
2119
	public static function get_option( $name, $default = false ) {
2120
		return Jetpack_Options::get_option( $name, $default );
2121
	}
2122
2123
	/**
2124
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2125
	 *
2126
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2127
	 * @param string $name  Option name
2128
	 * @param mixed  $value Option value
2129
	 */
2130
	public static function update_option( $name, $value ) {
2131
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2132
		return Jetpack_Options::update_option( $name, $value );
2133
	}
2134
2135
	/**
2136
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2137
	 *
2138
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2139
	 * @param array $array array( option name => option value, ... )
2140
	 */
2141
	public static function update_options( $array ) {
2142
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2143
		return Jetpack_Options::update_options( $array );
2144
	}
2145
2146
	/**
2147
	 * Deletes the given option.  May be passed multiple option names as an array.
2148
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2149
	 *
2150
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2151
	 * @param string|array $names
2152
	 */
2153
	public static function delete_option( $names ) {
2154
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2155
		return Jetpack_Options::delete_option( $names );
2156
	}
2157
2158
	/**
2159
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2160
	 *
2161
	 * Enters a user token into the user_tokens option
2162
	 *
2163
	 * @param int    $user_id The user id.
2164
	 * @param string $token The user token.
2165
	 * @param bool   $is_master_user Whether the user is the master user.
2166
	 * @return bool
2167
	 */
2168
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2169
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2170
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2171
	}
2172
2173
	/**
2174
	 * Returns an array of all PHP files in the specified absolute path.
2175
	 * Equivalent to glob( "$absolute_path/*.php" ).
2176
	 *
2177
	 * @param string $absolute_path The absolute path of the directory to search.
2178
	 * @return array Array of absolute paths to the PHP files.
2179
	 */
2180
	public static function glob_php( $absolute_path ) {
2181
		if ( function_exists( 'glob' ) ) {
2182
			return glob( "$absolute_path/*.php" );
2183
		}
2184
2185
		$absolute_path = untrailingslashit( $absolute_path );
2186
		$files         = array();
2187
		if ( ! $dir = @opendir( $absolute_path ) ) {
2188
			return $files;
2189
		}
2190
2191
		while ( false !== $file = readdir( $dir ) ) {
2192
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2193
				continue;
2194
			}
2195
2196
			$file = "$absolute_path/$file";
2197
2198
			if ( ! is_file( $file ) ) {
2199
				continue;
2200
			}
2201
2202
			$files[] = $file;
2203
		}
2204
2205
		closedir( $dir );
2206
2207
		return $files;
2208
	}
2209
2210
	public static function activate_new_modules( $redirect = false ) {
2211
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2212
			return;
2213
		}
2214
2215
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2216 View Code Duplication
		if ( ! $jetpack_old_version ) {
2217
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2218
			/** This action is documented in class.jetpack.php */
2219
			do_action( 'updating_jetpack_version', $version, false );
2220
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2221
		}
2222
2223
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2224
2225
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2226
			return;
2227
		}
2228
2229
		$active_modules     = self::get_active_modules();
2230
		$reactivate_modules = array();
2231
		foreach ( $active_modules as $active_module ) {
2232
			$module = self::get_module( $active_module );
2233
			if ( ! isset( $module['changed'] ) ) {
2234
				continue;
2235
			}
2236
2237
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2238
				continue;
2239
			}
2240
2241
			$reactivate_modules[] = $active_module;
2242
			self::deactivate_module( $active_module );
2243
		}
2244
2245
		$new_version = JETPACK__VERSION . ':' . time();
2246
		/** This action is documented in class.jetpack.php */
2247
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2248
		Jetpack_Options::update_options(
2249
			array(
2250
				'version'     => $new_version,
2251
				'old_version' => $jetpack_old_version,
2252
			)
2253
		);
2254
2255
		self::state( 'message', 'modules_activated' );
2256
		self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
0 ignored issues
show
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...
2257
2258
		if ( $redirect ) {
2259
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2260
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2261
				$page = $_GET['page'];
2262
			}
2263
2264
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2265
			exit;
2266
		}
2267
	}
2268
2269
	/**
2270
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2271
	 * Make sure to tuck away module "library" files in a sub-directory.
2272
	 */
2273
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2274
		static $modules = null;
2275
2276
		if ( ! isset( $modules ) ) {
2277
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2278
			// Use the cache if we're on the front-end and it's available...
2279
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2280
				$modules = $available_modules_option[ JETPACK__VERSION ];
2281
			} else {
2282
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2283
2284
				$modules = array();
2285
2286
				foreach ( $files as $file ) {
2287
					if ( ! $headers = self::get_module( $file ) ) {
2288
						continue;
2289
					}
2290
2291
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2292
				}
2293
2294
				Jetpack_Options::update_option(
2295
					'available_modules',
2296
					array(
2297
						JETPACK__VERSION => $modules,
2298
					)
2299
				);
2300
			}
2301
		}
2302
2303
		/**
2304
		 * Filters the array of modules available to be activated.
2305
		 *
2306
		 * @since 2.4.0
2307
		 *
2308
		 * @param array $modules Array of available modules.
2309
		 * @param string $min_version Minimum version number required to use modules.
2310
		 * @param string $max_version Maximum version number required to use modules.
2311
		 */
2312
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2313
2314
		if ( ! $min_version && ! $max_version ) {
2315
			return array_keys( $mods );
2316
		}
2317
2318
		$r = array();
2319
		foreach ( $mods as $slug => $introduced ) {
2320
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2321
				continue;
2322
			}
2323
2324
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2325
				continue;
2326
			}
2327
2328
			$r[] = $slug;
2329
		}
2330
2331
		return $r;
2332
	}
2333
2334
	/**
2335
	 * Default modules loaded on activation.
2336
	 */
2337
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2338
		$return = array();
2339
2340
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2341
			$module_data = self::get_module( $module );
2342
2343
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2344
				case 'yes':
2345
					$return[] = $module;
2346
					break;
2347
				case 'public':
2348
					if ( Jetpack_Options::get_option( 'public' ) ) {
2349
						$return[] = $module;
2350
					}
2351
					break;
2352
				case 'no':
2353
				default:
2354
					break;
2355
			}
2356
		}
2357
		/**
2358
		 * Filters the array of default modules.
2359
		 *
2360
		 * @since 2.5.0
2361
		 *
2362
		 * @param array $return Array of default modules.
2363
		 * @param string $min_version Minimum version number required to use modules.
2364
		 * @param string $max_version Maximum version number required to use modules.
2365
		 */
2366
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2367
	}
2368
2369
	/**
2370
	 * Checks activated modules during auto-activation to determine
2371
	 * if any of those modules are being deprecated.  If so, close
2372
	 * them out, and add any replacement modules.
2373
	 *
2374
	 * Runs at priority 99 by default.
2375
	 *
2376
	 * This is run late, so that it can still activate a module if
2377
	 * the new module is a replacement for another that the user
2378
	 * currently has active, even if something at the normal priority
2379
	 * would kibosh everything.
2380
	 *
2381
	 * @since 2.6
2382
	 * @uses jetpack_get_default_modules filter
2383
	 * @param array $modules
2384
	 * @return array
2385
	 */
2386
	function handle_deprecated_modules( $modules ) {
2387
		$deprecated_modules = array(
2388
			'debug'            => null,  // Closed out and moved to the debugger library.
2389
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2390
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2391
		);
2392
2393
		// Don't activate SSO if they never completed activating WPCC.
2394
		if ( self::is_module_active( 'wpcc' ) ) {
2395
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2396
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2397
				$deprecated_modules['wpcc'] = null;
2398
			}
2399
		}
2400
2401
		foreach ( $deprecated_modules as $module => $replacement ) {
2402
			if ( self::is_module_active( $module ) ) {
2403
				self::deactivate_module( $module );
2404
				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...
2405
					$modules[] = $replacement;
2406
				}
2407
			}
2408
		}
2409
2410
		return array_unique( $modules );
2411
	}
2412
2413
	/**
2414
	 * Checks activated plugins during auto-activation to determine
2415
	 * if any of those plugins are in the list with a corresponding module
2416
	 * that is not compatible with the plugin. The module will not be allowed
2417
	 * to auto-activate.
2418
	 *
2419
	 * @since 2.6
2420
	 * @uses jetpack_get_default_modules filter
2421
	 * @param array $modules
2422
	 * @return array
2423
	 */
2424
	function filter_default_modules( $modules ) {
2425
2426
		$active_plugins = self::get_active_plugins();
2427
2428
		if ( ! empty( $active_plugins ) ) {
2429
2430
			// For each module we'd like to auto-activate...
2431
			foreach ( $modules as $key => $module ) {
2432
				// If there are potential conflicts for it...
2433
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2434
					// For each potential conflict...
2435
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2436
						// If that conflicting plugin is active...
2437
						if ( in_array( $plugin, $active_plugins ) ) {
2438
							// Remove that item from being auto-activated.
2439
							unset( $modules[ $key ] );
2440
						}
2441
					}
2442
				}
2443
			}
2444
		}
2445
2446
		return $modules;
2447
	}
2448
2449
	/**
2450
	 * Extract a module's slug from its full path.
2451
	 */
2452
	public static function get_module_slug( $file ) {
2453
		return str_replace( '.php', '', basename( $file ) );
2454
	}
2455
2456
	/**
2457
	 * Generate a module's path from its slug.
2458
	 */
2459
	public static function get_module_path( $slug ) {
2460
		/**
2461
		 * Filters the path of a modules.
2462
		 *
2463
		 * @since 7.4.0
2464
		 *
2465
		 * @param array $return The absolute path to a module's root php file
2466
		 * @param string $slug The module slug
2467
		 */
2468
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2469
	}
2470
2471
	/**
2472
	 * Load module data from module file. Headers differ from WordPress
2473
	 * plugin headers to avoid them being identified as standalone
2474
	 * plugins on the WordPress plugins page.
2475
	 */
2476
	public static function get_module( $module ) {
2477
		$headers = array(
2478
			'name'                      => 'Module Name',
2479
			'description'               => 'Module Description',
2480
			'sort'                      => 'Sort Order',
2481
			'recommendation_order'      => 'Recommendation Order',
2482
			'introduced'                => 'First Introduced',
2483
			'changed'                   => 'Major Changes In',
2484
			'deactivate'                => 'Deactivate',
2485
			'free'                      => 'Free',
2486
			'requires_connection'       => 'Requires Connection',
2487
			'auto_activate'             => 'Auto Activate',
2488
			'module_tags'               => 'Module Tags',
2489
			'feature'                   => 'Feature',
2490
			'additional_search_queries' => 'Additional Search Queries',
2491
			'plan_classes'              => 'Plans',
2492
		);
2493
2494
		$file = self::get_module_path( self::get_module_slug( $module ) );
2495
2496
		$mod = self::get_file_data( $file, $headers );
2497
		if ( empty( $mod['name'] ) ) {
2498
			return false;
2499
		}
2500
2501
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2502
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2503
		$mod['deactivate']           = empty( $mod['deactivate'] );
2504
		$mod['free']                 = empty( $mod['free'] );
2505
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2506
2507
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2508
			$mod['auto_activate'] = 'No';
2509
		} else {
2510
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2511
		}
2512
2513
		if ( $mod['module_tags'] ) {
2514
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2515
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2516
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2517
		} else {
2518
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2519
		}
2520
2521 View Code Duplication
		if ( $mod['plan_classes'] ) {
2522
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2523
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2524
		} else {
2525
			$mod['plan_classes'] = array( 'free' );
2526
		}
2527
2528 View Code Duplication
		if ( $mod['feature'] ) {
2529
			$mod['feature'] = explode( ',', $mod['feature'] );
2530
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2531
		} else {
2532
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2533
		}
2534
2535
		/**
2536
		 * Filters the feature array on a module.
2537
		 *
2538
		 * This filter allows you to control where each module is filtered: Recommended,
2539
		 * and the default "Other" listing.
2540
		 *
2541
		 * @since 3.5.0
2542
		 *
2543
		 * @param array   $mod['feature'] The areas to feature this module:
2544
		 *     'Recommended' shows on the main Jetpack admin screen.
2545
		 *     'Other' should be the default if no other value is in the array.
2546
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2547
		 * @param array   $mod All the currently assembled module data.
2548
		 */
2549
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2550
2551
		/**
2552
		 * Filter the returned data about a module.
2553
		 *
2554
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2555
		 * so please be careful.
2556
		 *
2557
		 * @since 3.6.0
2558
		 *
2559
		 * @param array   $mod    The details of the requested module.
2560
		 * @param string  $module The slug of the module, e.g. sharedaddy
2561
		 * @param string  $file   The path to the module source file.
2562
		 */
2563
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2564
	}
2565
2566
	/**
2567
	 * Like core's get_file_data implementation, but caches the result.
2568
	 */
2569
	public static function get_file_data( $file, $headers ) {
2570
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2571
		$file_name = basename( $file );
2572
2573
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2574
2575
		$file_data_option = get_transient( $cache_key );
2576
2577
		if ( ! is_array( $file_data_option ) ) {
2578
			delete_transient( $cache_key );
2579
			$file_data_option = false;
2580
		}
2581
2582
		if ( false === $file_data_option ) {
2583
			$file_data_option = array();
2584
		}
2585
2586
		$key           = md5( $file_name . serialize( $headers ) );
2587
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2588
2589
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2590
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2591
			return $file_data_option[ $key ];
2592
		}
2593
2594
		$data = get_file_data( $file, $headers );
2595
2596
		$file_data_option[ $key ] = $data;
2597
2598
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2599
2600
		return $data;
2601
	}
2602
2603
2604
	/**
2605
	 * Return translated module tag.
2606
	 *
2607
	 * @param string $tag Tag as it appears in each module heading.
2608
	 *
2609
	 * @return mixed
2610
	 */
2611
	public static function translate_module_tag( $tag ) {
2612
		return jetpack_get_module_i18n_tag( $tag );
2613
	}
2614
2615
	/**
2616
	 * Get i18n strings as a JSON-encoded string
2617
	 *
2618
	 * @return string The locale as JSON
2619
	 */
2620
	public static function get_i18n_data_json() {
2621
2622
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2623
		// JSON files with the file they should be included for. This is an md5
2624
		// of '_inc/build/admin.js'.
2625
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2626
2627
		$i18n_json =
2628
				   JETPACK__PLUGIN_DIR
2629
				   . 'languages/json/jetpack-'
2630
				   . get_user_locale()
2631
				   . '-'
2632
				   . $path_md5
2633
				   . '.json';
2634
2635
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2636
			$locale_data = @file_get_contents( $i18n_json );
2637
			if ( $locale_data ) {
2638
				return $locale_data;
2639
			}
2640
		}
2641
2642
		// Return valid empty Jed locale
2643
		return '{ "locale_data": { "messages": { "": {} } } }';
2644
	}
2645
2646
	/**
2647
	 * Add locale data setup to wp-i18n
2648
	 *
2649
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2650
	 *
2651
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2652
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2653
	 *
2654
	 * This method provides a safe way to request the setup multiple times but add the script at
2655
	 * most once.
2656
	 *
2657
	 * @since 6.7.0
2658
	 *
2659
	 * @return void
2660
	 */
2661
	public static function setup_wp_i18n_locale_data() {
2662
		static $script_added = false;
2663
		if ( ! $script_added ) {
2664
			$script_added = true;
2665
			wp_add_inline_script(
2666
				'wp-i18n',
2667
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2668
			);
2669
		}
2670
	}
2671
2672
	/**
2673
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2674
	 *
2675
	 * @since 3.9.2
2676
	 *
2677
	 * @param array $modules
2678
	 *
2679
	 * @return string|void
2680
	 */
2681
	public static function get_translated_modules( $modules ) {
2682
		foreach ( $modules as $index => $module ) {
2683
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2684
			if ( isset( $module['name'] ) ) {
2685
				$modules[ $index ]['name'] = $i18n_module['name'];
2686
			}
2687
			if ( isset( $module['description'] ) ) {
2688
				$modules[ $index ]['description']       = $i18n_module['description'];
2689
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2690
			}
2691
		}
2692
		return $modules;
2693
	}
2694
2695
	/**
2696
	 * Get a list of activated modules as an array of module slugs.
2697
	 */
2698
	public static function get_active_modules() {
2699
		$active = Jetpack_Options::get_option( 'active_modules' );
2700
2701
		if ( ! is_array( $active ) ) {
2702
			$active = array();
2703
		}
2704
2705
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2706
			$active[] = 'vaultpress';
2707
		} else {
2708
			$active = array_diff( $active, array( 'vaultpress' ) );
2709
		}
2710
2711
		// If protect is active on the main site of a multisite, it should be active on all sites.
2712
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2713
			$active[] = 'protect';
2714
		}
2715
2716
		/**
2717
		 * Allow filtering of the active modules.
2718
		 *
2719
		 * Gives theme and plugin developers the power to alter the modules that
2720
		 * are activated on the fly.
2721
		 *
2722
		 * @since 5.8.0
2723
		 *
2724
		 * @param array $active Array of active module slugs.
2725
		 */
2726
		$active = apply_filters( 'jetpack_active_modules', $active );
2727
2728
		return array_unique( $active );
2729
	}
2730
2731
	/**
2732
	 * Check whether or not a Jetpack module is active.
2733
	 *
2734
	 * @param string $module The slug of a Jetpack module.
2735
	 * @return bool
2736
	 *
2737
	 * @static
2738
	 */
2739
	public static function is_module_active( $module ) {
2740
		return in_array( $module, self::get_active_modules() );
2741
	}
2742
2743
	public static function is_module( $module ) {
2744
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2745
	}
2746
2747
	/**
2748
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2749
	 *
2750
	 * @param bool $catch True to start catching, False to stop.
2751
	 *
2752
	 * @static
2753
	 */
2754
	public static function catch_errors( $catch ) {
2755
		static $display_errors, $error_reporting;
2756
2757
		if ( $catch ) {
2758
			$display_errors  = @ini_set( 'display_errors', 1 );
2759
			$error_reporting = @error_reporting( E_ALL );
2760
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2761
		} else {
2762
			@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...
2763
			@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...
2764
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2765
		}
2766
	}
2767
2768
	/**
2769
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2770
	 */
2771
	public static function catch_errors_on_shutdown() {
2772
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2773
	}
2774
2775
	/**
2776
	 * Rewrite any string to make paths easier to read.
2777
	 *
2778
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2779
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2780
	 *
2781
	 * @param $string
2782
	 * @return mixed
2783
	 */
2784
	public static function alias_directories( $string ) {
2785
		// ABSPATH has a trailing slash.
2786
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2787
		// WP_CONTENT_DIR does not have a trailing slash.
2788
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2789
2790
		return $string;
2791
	}
2792
2793
	public static function activate_default_modules(
2794
		$min_version = false,
2795
		$max_version = false,
2796
		$other_modules = array(),
2797
		$redirect = null,
2798
		$send_state_messages = null
2799
	) {
2800
		$jetpack = self::init();
2801
2802
		if ( is_null( $redirect ) ) {
2803
			if (
2804
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2805
			||
2806
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2807
			||
2808
				( defined( 'WP_CLI' ) && WP_CLI )
2809
			||
2810
				( defined( 'DOING_CRON' ) && DOING_CRON )
2811
			||
2812
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2813
			) {
2814
				$redirect = false;
2815
			} elseif ( is_admin() ) {
2816
				$redirect = true;
2817
			} else {
2818
				$redirect = false;
2819
			}
2820
		}
2821
2822
		if ( is_null( $send_state_messages ) ) {
2823
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2824
		}
2825
2826
		$modules = self::get_default_modules( $min_version, $max_version );
2827
		$modules = array_merge( $other_modules, $modules );
2828
2829
		// Look for standalone plugins and disable if active.
2830
2831
		$to_deactivate = array();
2832
		foreach ( $modules as $module ) {
2833
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2834
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2835
			}
2836
		}
2837
2838
		$deactivated = array();
2839
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2840
			list( $probable_file, $probable_title ) = $deactivate_me;
2841
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2842
				$deactivated[] = $module;
2843
			}
2844
		}
2845
2846
		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...
2847
			if ( $send_state_messages ) {
2848
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2849
			}
2850
2851
			if ( $redirect ) {
2852
				$url = add_query_arg(
2853
					array(
2854
						'action'   => 'activate_default_modules',
2855
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2856
					),
2857
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2858
				);
2859
				wp_safe_redirect( $url );
2860
				exit;
2861
			}
2862
		}
2863
2864
		/**
2865
		 * Fires before default modules are activated.
2866
		 *
2867
		 * @since 1.9.0
2868
		 *
2869
		 * @param string $min_version Minimum version number required to use modules.
2870
		 * @param string $max_version Maximum version number required to use modules.
2871
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2872
		 */
2873
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2874
2875
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2876
		if ( $send_state_messages ) {
2877
			self::restate();
2878
			self::catch_errors( true );
2879
		}
2880
2881
		$active = self::get_active_modules();
2882
2883
		foreach ( $modules as $module ) {
2884
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2885
				$active[] = $module;
2886
				self::update_active_modules( $active );
2887
				continue;
2888
			}
2889
2890
			if ( $send_state_messages && in_array( $module, $active ) ) {
2891
				$module_info = self::get_module( $module );
2892 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2893
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2894
					if ( $active_state = self::state( $state ) ) {
2895
						$active_state = explode( ',', $active_state );
2896
					} else {
2897
						$active_state = array();
2898
					}
2899
					$active_state[] = $module;
2900
					self::state( $state, implode( ',', $active_state ) );
2901
				}
2902
				continue;
2903
			}
2904
2905
			$file = self::get_module_path( $module );
2906
			if ( ! file_exists( $file ) ) {
2907
				continue;
2908
			}
2909
2910
			// we'll override this later if the plugin can be included without fatal error
2911
			if ( $redirect ) {
2912
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2913
			}
2914
2915
			if ( $send_state_messages ) {
2916
				self::state( 'error', 'module_activation_failed' );
2917
				self::state( 'module', $module );
2918
			}
2919
2920
			ob_start();
2921
			require_once $file;
2922
2923
			$active[] = $module;
2924
2925 View Code Duplication
			if ( $send_state_messages ) {
2926
2927
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2928
				if ( $active_state = self::state( $state ) ) {
2929
					$active_state = explode( ',', $active_state );
2930
				} else {
2931
					$active_state = array();
2932
				}
2933
				$active_state[] = $module;
2934
				self::state( $state, implode( ',', $active_state ) );
2935
			}
2936
2937
			self::update_active_modules( $active );
2938
2939
			ob_end_clean();
2940
		}
2941
2942
		if ( $send_state_messages ) {
2943
			self::state( 'error', false );
0 ignored issues
show
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...
2944
			self::state( 'module', false );
0 ignored issues
show
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...
2945
		}
2946
2947
		self::catch_errors( false );
2948
		/**
2949
		 * Fires when default modules are activated.
2950
		 *
2951
		 * @since 1.9.0
2952
		 *
2953
		 * @param string $min_version Minimum version number required to use modules.
2954
		 * @param string $max_version Maximum version number required to use modules.
2955
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2956
		 */
2957
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2958
	}
2959
2960
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2961
		/**
2962
		 * Fires before a module is activated.
2963
		 *
2964
		 * @since 2.6.0
2965
		 *
2966
		 * @param string $module Module slug.
2967
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2968
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2969
		 */
2970
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2971
2972
		$jetpack = self::init();
2973
2974
		if ( ! strlen( $module ) ) {
2975
			return false;
2976
		}
2977
2978
		if ( ! self::is_module( $module ) ) {
2979
			return false;
2980
		}
2981
2982
		// If it's already active, then don't do it again
2983
		$active = self::get_active_modules();
2984
		foreach ( $active as $act ) {
2985
			if ( $act == $module ) {
2986
				return true;
2987
			}
2988
		}
2989
2990
		$module_data = self::get_module( $module );
2991
2992
		$is_development_mode = ( new Status() )->is_development_mode();
2993
		if ( ! self::is_active() ) {
2994
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
2995
				return false;
2996
			}
2997
2998
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2999
			if ( $is_development_mode && $module_data['requires_connection'] ) {
3000
				return false;
3001
			}
3002
		}
3003
3004
		// Check and see if the old plugin is active
3005
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3006
			// Deactivate the old plugin
3007
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3008
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3009
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3010
				self::state( 'deactivated_plugins', $module );
3011
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3012
				exit;
3013
			}
3014
		}
3015
3016
		// Protect won't work with mis-configured IPs
3017
		if ( 'protect' === $module ) {
3018
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3019
			if ( ! jetpack_protect_get_ip() ) {
3020
				self::state( 'message', 'protect_misconfigured_ip' );
3021
				return false;
3022
			}
3023
		}
3024
3025
		if ( ! Jetpack_Plan::supports( $module ) ) {
3026
			return false;
3027
		}
3028
3029
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3030
		self::state( 'module', $module );
3031
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3032
3033
		self::catch_errors( true );
3034
		ob_start();
3035
		require self::get_module_path( $module );
3036
		/** This action is documented in class.jetpack.php */
3037
		do_action( 'jetpack_activate_module', $module );
3038
		$active[] = $module;
3039
		self::update_active_modules( $active );
3040
3041
		self::state( 'error', false ); // the override
0 ignored issues
show
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...
3042
		ob_end_clean();
3043
		self::catch_errors( false );
3044
3045
		if ( $redirect ) {
3046
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3047
		}
3048
		if ( $exit ) {
3049
			exit;
3050
		}
3051
		return true;
3052
	}
3053
3054
	function activate_module_actions( $module ) {
3055
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3056
	}
3057
3058
	public static function deactivate_module( $module ) {
3059
		/**
3060
		 * Fires when a module is deactivated.
3061
		 *
3062
		 * @since 1.9.0
3063
		 *
3064
		 * @param string $module Module slug.
3065
		 */
3066
		do_action( 'jetpack_pre_deactivate_module', $module );
3067
3068
		$jetpack = self::init();
0 ignored issues
show
$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...
3069
3070
		$active = self::get_active_modules();
3071
		$new    = array_filter( array_diff( $active, (array) $module ) );
3072
3073
		return self::update_active_modules( $new );
3074
	}
3075
3076
	public static function enable_module_configurable( $module ) {
3077
		$module = self::get_module_slug( $module );
3078
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3079
	}
3080
3081
	/**
3082
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3083
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3084
	 *
3085
	 * @param string $module Module slug
3086
	 * @return string $url module configuration URL
3087
	 */
3088
	public static function module_configuration_url( $module ) {
3089
		$module      = self::get_module_slug( $module );
3090
		$default_url = self::admin_url() . "#/settings?term=$module";
3091
		/**
3092
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3093
		 *
3094
		 * @since 6.9.0
3095
		 *
3096
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3097
		 */
3098
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3099
3100
		return $url;
3101
	}
3102
3103
	/* Installation */
3104
	public static function bail_on_activation( $message, $deactivate = true ) {
3105
		?>
3106
<!doctype html>
3107
<html>
3108
<head>
3109
<meta charset="<?php bloginfo( 'charset' ); ?>">
3110
<style>
3111
* {
3112
	text-align: center;
3113
	margin: 0;
3114
	padding: 0;
3115
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3116
}
3117
p {
3118
	margin-top: 1em;
3119
	font-size: 18px;
3120
}
3121
</style>
3122
<body>
3123
<p><?php echo esc_html( $message ); ?></p>
3124
</body>
3125
</html>
3126
		<?php
3127
		if ( $deactivate ) {
3128
			$plugins = get_option( 'active_plugins' );
3129
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3130
			$update  = false;
3131
			foreach ( $plugins as $i => $plugin ) {
3132
				if ( $plugin === $jetpack ) {
3133
					$plugins[ $i ] = false;
3134
					$update        = true;
3135
				}
3136
			}
3137
3138
			if ( $update ) {
3139
				update_option( 'active_plugins', array_filter( $plugins ) );
3140
			}
3141
		}
3142
		exit;
3143
	}
3144
3145
	/**
3146
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3147
	 *
3148
	 * @static
3149
	 */
3150
	public static function plugin_activation( $network_wide ) {
3151
		Jetpack_Options::update_option( 'activated', 1 );
3152
3153
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3154
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3155
		}
3156
3157
		if ( $network_wide ) {
3158
			self::state( 'network_nag', true );
0 ignored issues
show
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...
3159
		}
3160
3161
		// For firing one-off events (notices) immediately after activation
3162
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3163
3164
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3165
3166
		if ( false === Health::is_status_defined() ) {
3167
			Health::update_status( Health::STATUS_INITIALIZING );
3168
		}
3169
3170
		self::plugin_initialize();
3171
	}
3172
3173
	public static function get_activation_source( $referer_url ) {
3174
3175
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3176
			return array( 'wp-cli', null );
3177
		}
3178
3179
		$referer = wp_parse_url( $referer_url );
3180
3181
		$source_type  = 'unknown';
3182
		$source_query = null;
3183
3184
		if ( ! is_array( $referer ) ) {
3185
			return array( $source_type, $source_query );
3186
		}
3187
3188
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3189
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3190
3191
		if ( isset( $referer['query'] ) ) {
3192
			parse_str( $referer['query'], $query_parts );
3193
		} else {
3194
			$query_parts = array();
3195
		}
3196
3197
		if ( $plugins_path === $referer['path'] ) {
3198
			$source_type = 'list';
3199
		} elseif ( $plugins_install_path === $referer['path'] ) {
3200
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3201
			switch ( $tab ) {
3202
				case 'popular':
3203
					$source_type = 'popular';
3204
					break;
3205
				case 'recommended':
3206
					$source_type = 'recommended';
3207
					break;
3208
				case 'favorites':
3209
					$source_type = 'favorites';
3210
					break;
3211
				case 'search':
3212
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3213
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3214
					break;
3215
				default:
3216
					$source_type = 'featured';
3217
			}
3218
		}
3219
3220
		return array( $source_type, $source_query );
3221
	}
3222
3223
	/**
3224
	 * Runs before bumping version numbers up to a new version
3225
	 *
3226
	 * @param  string $version    Version:timestamp
3227
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3228
	 * @return null              [description]
3229
	 */
3230
	public static function do_version_bump( $version, $old_version ) {
3231
		if ( ! $old_version ) { // For new sites
3232
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3233
		}
3234
	}
3235
3236
	/**
3237
	 * Sets the internal version number and activation state.
3238
	 *
3239
	 * @static
3240
	 */
3241
	public static function plugin_initialize() {
3242
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3243
			Jetpack_Options::update_option( 'activated', 2 );
3244
		}
3245
3246 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3247
			$version = $old_version = JETPACK__VERSION . ':' . time();
3248
			/** This action is documented in class.jetpack.php */
3249
			do_action( 'updating_jetpack_version', $version, false );
3250
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3251
		}
3252
3253
		self::load_modules();
3254
3255
		Jetpack_Options::delete_option( 'do_activate' );
3256
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3257
	}
3258
3259
	/**
3260
	 * Removes all connection options
3261
	 *
3262
	 * @static
3263
	 */
3264
	public static function plugin_deactivation() {
3265
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3266
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3267
			Jetpack_Network::init()->deactivate();
3268
		} else {
3269
			self::disconnect( false );
3270
			// Jetpack_Heartbeat::init()->deactivate();
3271
		}
3272
	}
3273
3274
	/**
3275
	 * Disconnects from the Jetpack servers.
3276
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3277
	 *
3278
	 * @static
3279
	 */
3280
	public static function disconnect( $update_activated_state = true ) {
3281
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3282
		$connection = self::connection();
3283
		$connection->clean_nonces( true );
3284
3285
		// If the site is in an IDC because sync is not allowed,
3286
		// let's make sure to not disconnect the production site.
3287
		if ( ! self::validate_sync_error_idc_option() ) {
3288
			$tracking = new Tracking();
3289
			$tracking->record_user_event( 'disconnect_site', array() );
3290
3291
			$connection->disconnect_site_wpcom();
3292
		}
3293
3294
		$connection->delete_all_connection_tokens();
3295
		Jetpack_IDC::clear_all_idc_options();
3296
3297
		if ( $update_activated_state ) {
3298
			Jetpack_Options::update_option( 'activated', 4 );
3299
		}
3300
3301
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3302
			// Check then record unique disconnection if site has never been disconnected previously
3303
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3304
				$jetpack_unique_connection['disconnected'] = 1;
3305
			} else {
3306
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3307
					// track unique disconnect
3308
					$jetpack = self::init();
3309
3310
					$jetpack->stat( 'connections', 'unique-disconnect' );
3311
					$jetpack->do_stats( 'server_side' );
3312
				}
3313
				// increment number of times disconnected
3314
				$jetpack_unique_connection['disconnected'] += 1;
3315
			}
3316
3317
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3318
		}
3319
3320
		// Delete all the sync related data. Since it could be taking up space.
3321
		Sender::get_instance()->uninstall();
3322
3323
		// Disable the Heartbeat cron
3324
		Jetpack_Heartbeat::init()->deactivate();
3325
	}
3326
3327
	/**
3328
	 * Unlinks the current user from the linked WordPress.com user.
3329
	 *
3330
	 * @deprecated since 7.7
3331
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3332
	 *
3333
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
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...
3334
	 * @return Boolean Whether the disconnection of the user was successful.
3335
	 */
3336
	public static function unlink_user( $user_id = null ) {
3337
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3338
		return Connection_Manager::disconnect_user( $user_id );
3339
	}
3340
3341
	/**
3342
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3343
	 */
3344
	public static function try_registration() {
3345
		$terms_of_service = new Terms_Of_Service();
3346
		// The user has agreed to the TOS at some point by now.
3347
		$terms_of_service->agree();
3348
3349
		// Let's get some testing in beta versions and such.
3350
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3351
			// Before attempting to connect, let's make sure that the domains are viable.
3352
			$domains_to_check = array_unique(
3353
				array(
3354
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3355
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3356
				)
3357
			);
3358
			foreach ( $domains_to_check as $domain ) {
3359
				$result = self::connection()->is_usable_domain( $domain );
3360
				if ( is_wp_error( $result ) ) {
3361
					return $result;
3362
				}
3363
			}
3364
		}
3365
3366
		$result = self::register();
3367
3368
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3369
		if ( ! $result || is_wp_error( $result ) ) {
3370
			return $result;
3371
		} else {
3372
			return true;
3373
		}
3374
	}
3375
3376
	/**
3377
	 * Tracking an internal event log. Try not to put too much chaff in here.
3378
	 *
3379
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3380
	 */
3381
	public static function log( $code, $data = null ) {
3382
		// only grab the latest 200 entries
3383
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3384
3385
		// Append our event to the log
3386
		$log_entry = array(
3387
			'time'    => time(),
3388
			'user_id' => get_current_user_id(),
3389
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3390
			'code'    => $code,
3391
		);
3392
		// Don't bother storing it unless we've got some.
3393
		if ( ! is_null( $data ) ) {
3394
			$log_entry['data'] = $data;
3395
		}
3396
		$log[] = $log_entry;
3397
3398
		// Try add_option first, to make sure it's not autoloaded.
3399
		// @todo: Add an add_option method to Jetpack_Options
3400
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3401
			Jetpack_Options::update_option( 'log', $log );
3402
		}
3403
3404
		/**
3405
		 * Fires when Jetpack logs an internal event.
3406
		 *
3407
		 * @since 3.0.0
3408
		 *
3409
		 * @param array $log_entry {
3410
		 *  Array of details about the log entry.
3411
		 *
3412
		 *  @param string time Time of the event.
3413
		 *  @param int user_id ID of the user who trigerred the event.
3414
		 *  @param int blog_id Jetpack Blog ID.
3415
		 *  @param string code Unique name for the event.
3416
		 *  @param string data Data about the event.
3417
		 * }
3418
		 */
3419
		do_action( 'jetpack_log_entry', $log_entry );
3420
	}
3421
3422
	/**
3423
	 * Get the internal event log.
3424
	 *
3425
	 * @param $event (string) - only return the specific log events
3426
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3427
	 *
3428
	 * @return array of log events || WP_Error for invalid params
3429
	 */
3430
	public static function get_log( $event = false, $num = false ) {
3431
		if ( $event && ! is_string( $event ) ) {
3432
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
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...
3433
		}
3434
3435
		if ( $num && ! is_numeric( $num ) ) {
3436
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
0 ignored issues
show
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...
3437
		}
3438
3439
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3440
3441
		// If nothing set - act as it did before, otherwise let's start customizing the output
3442
		if ( ! $num && ! $event ) {
3443
			return $entire_log;
3444
		} else {
3445
			$entire_log = array_reverse( $entire_log );
3446
		}
3447
3448
		$custom_log_output = array();
3449
3450
		if ( $event ) {
3451
			foreach ( $entire_log as $log_event ) {
3452
				if ( $event == $log_event['code'] ) {
3453
					$custom_log_output[] = $log_event;
3454
				}
3455
			}
3456
		} else {
3457
			$custom_log_output = $entire_log;
3458
		}
3459
3460
		if ( $num ) {
3461
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3462
		}
3463
3464
		return $custom_log_output;
3465
	}
3466
3467
	/**
3468
	 * Log modification of important settings.
3469
	 */
3470
	public static function log_settings_change( $option, $old_value, $value ) {
3471
		switch ( $option ) {
3472
			case 'jetpack_sync_non_public_post_stati':
3473
				self::log( $option, $value );
3474
				break;
3475
		}
3476
	}
3477
3478
	/**
3479
	 * Return stat data for WPCOM sync
3480
	 */
3481
	public static function get_stat_data( $encode = true, $extended = true ) {
3482
		$data = Jetpack_Heartbeat::generate_stats_array();
3483
3484
		if ( $extended ) {
3485
			$additional_data = self::get_additional_stat_data();
3486
			$data            = array_merge( $data, $additional_data );
3487
		}
3488
3489
		if ( $encode ) {
3490
			return json_encode( $data );
3491
		}
3492
3493
		return $data;
3494
	}
3495
3496
	/**
3497
	 * Get additional stat data to sync to WPCOM
3498
	 */
3499
	public static function get_additional_stat_data( $prefix = '' ) {
3500
		$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...
3501
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3502
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3503
		$return[ "{$prefix}site-count" ]    = 0;
3504
3505
		if ( function_exists( 'get_blog_count' ) ) {
3506
			$return[ "{$prefix}site-count" ] = get_blog_count();
3507
		}
3508
		return $return;
3509
	}
3510
3511
	private static function get_site_user_count() {
3512
		global $wpdb;
3513
3514
		if ( function_exists( 'wp_is_large_network' ) ) {
3515
			if ( wp_is_large_network( 'users' ) ) {
3516
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3517
			}
3518
		}
3519
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3520
			// It wasn't there, so regenerate the data and save the transient
3521
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3522
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3523
		}
3524
		return $user_count;
3525
	}
3526
3527
	/* Admin Pages */
3528
3529
	function admin_init() {
3530
		// If the plugin is not connected, display a connect message.
3531
		if (
3532
			// the plugin was auto-activated and needs its candy
3533
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3534
		||
3535
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3536
			! Jetpack_Options::get_option( 'activated' )
3537
		) {
3538
			self::plugin_initialize();
3539
		}
3540
3541
		$is_development_mode = ( new Status() )->is_development_mode();
3542
		if ( ! self::is_active() && ! $is_development_mode ) {
3543
			Jetpack_Connection_Banner::init();
3544
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3545
			// Upgrade: 1.1 -> 1.1.1
3546
			// Check and see if host can verify the Jetpack servers' SSL certificate
3547
			$args       = array();
3548
			$connection = self::connection();
3549
			Client::_wp_remote_request(
3550
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3551
				$args,
3552
				true
3553
			);
3554
		}
3555
3556
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3557
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3558
		}
3559
3560
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3561
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3562
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3563
3564
		if ( self::is_active() || $is_development_mode ) {
3565
			// Artificially throw errors in certain whitelisted cases during plugin activation
3566
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3567
		}
3568
3569
		// Add custom column in wp-admin/users.php to show whether user is linked.
3570
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3571
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3572
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3573
	}
3574
3575
	function admin_body_class( $admin_body_class = '' ) {
3576
		$classes = explode( ' ', trim( $admin_body_class ) );
3577
3578
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3579
3580
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3581
		return " $admin_body_class ";
3582
	}
3583
3584
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3585
		return $admin_body_class . ' jetpack-pagestyles ';
3586
	}
3587
3588
	/**
3589
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3590
	 * This function artificially throws errors for such cases (whitelisted).
3591
	 *
3592
	 * @param string $plugin The activated plugin.
3593
	 */
3594
	function throw_error_on_activate_plugin( $plugin ) {
3595
		$active_modules = self::get_active_modules();
3596
3597
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3598
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3599
			$throw = false;
3600
3601
			// Try and make sure it really was the stats plugin
3602
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3603
				if ( 'stats.php' == basename( $plugin ) ) {
3604
					$throw = true;
3605
				}
3606
			} else {
3607
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3608
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3609
					$throw = true;
3610
				}
3611
			}
3612
3613
			if ( $throw ) {
3614
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3615
			}
3616
		}
3617
	}
3618
3619
	function intercept_plugin_error_scrape_init() {
3620
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3621
	}
3622
3623
	function intercept_plugin_error_scrape( $action, $result ) {
3624
		if ( ! $result ) {
3625
			return;
3626
		}
3627
3628
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3629
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3630
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3631
			}
3632
		}
3633
	}
3634
3635
	/**
3636
	 * Register the remote file upload request handlers, if needed.
3637
	 *
3638
	 * @access public
3639
	 */
3640
	public function add_remote_request_handlers() {
3641
		// Remote file uploads are allowed only via AJAX requests.
3642
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3643
			return;
3644
		}
3645
3646
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3647
		$remote_request_actions = array(
3648
			'jetpack_upload_file',
3649
			'jetpack_update_file',
3650
		);
3651
3652
		// phpcs:ignore WordPress.Security.NonceVerification
3653
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3654
			return;
3655
		}
3656
3657
		// Require Jetpack authentication for the remote file upload AJAX requests.
3658
		$this->connection_manager->require_jetpack_authentication();
3659
3660
		// Register the remote file upload AJAX handlers.
3661
		foreach ( $remote_request_actions as $action ) {
3662
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3663
		}
3664
	}
3665
3666
	/**
3667
	 * Handler for Jetpack remote file uploads.
3668
	 *
3669
	 * @access public
3670
	 */
3671
	public function remote_request_handlers() {
3672
		$action = current_filter();
0 ignored issues
show
$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...
3673
3674
		switch ( current_filter() ) {
3675
			case 'wp_ajax_nopriv_jetpack_upload_file':
3676
				$response = $this->upload_handler();
3677
				break;
3678
3679
			case 'wp_ajax_nopriv_jetpack_update_file':
3680
				$response = $this->upload_handler( true );
3681
				break;
3682
			default:
3683
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
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...
3684
				break;
3685
		}
3686
3687
		if ( ! $response ) {
3688
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
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...
3689
		}
3690
3691
		if ( is_wp_error( $response ) ) {
3692
			$status_code       = $response->get_error_data();
0 ignored issues
show
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...
3693
			$error             = $response->get_error_code();
0 ignored issues
show
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...
3694
			$error_description = $response->get_error_message();
0 ignored issues
show
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...
3695
3696
			if ( ! is_int( $status_code ) ) {
3697
				$status_code = 400;
3698
			}
3699
3700
			status_header( $status_code );
3701
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3702
		}
3703
3704
		status_header( 200 );
3705
		if ( true === $response ) {
3706
			exit;
3707
		}
3708
3709
		die( json_encode( (object) $response ) );
3710
	}
3711
3712
	/**
3713
	 * Uploads a file gotten from the global $_FILES.
3714
	 * If `$update_media_item` is true and `post_id` is defined
3715
	 * the attachment file of the media item (gotten through of the post_id)
3716
	 * will be updated instead of add a new one.
3717
	 *
3718
	 * @param  boolean $update_media_item - update media attachment
3719
	 * @return array - An array describing the uploadind files process
3720
	 */
3721
	function upload_handler( $update_media_item = false ) {
3722
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3723
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
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...
3724
		}
3725
3726
		$user = wp_authenticate( '', '' );
3727
		if ( ! $user || is_wp_error( $user ) ) {
3728
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
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...
3729
		}
3730
3731
		wp_set_current_user( $user->ID );
3732
3733
		if ( ! current_user_can( 'upload_files' ) ) {
3734
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
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...
3735
		}
3736
3737
		if ( empty( $_FILES ) ) {
3738
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
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...
3739
		}
3740
3741
		foreach ( array_keys( $_FILES ) as $files_key ) {
3742
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3743
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
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...
3744
			}
3745
		}
3746
3747
		$media_keys = array_keys( $_FILES['media'] );
3748
3749
		$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...
3750
		if ( ! $token || is_wp_error( $token ) ) {
3751
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
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...
3752
		}
3753
3754
		$uploaded_files = array();
3755
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3756
		unset( $GLOBALS['post'] );
3757
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3758
			$file = array();
3759
			foreach ( $media_keys as $media_key ) {
3760
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3761
			}
3762
3763
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3764
3765
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3766
			if ( $hmac_provided !== $hmac_file ) {
3767
				$uploaded_files[ $index ] = (object) array(
3768
					'error'             => 'invalid_hmac',
3769
					'error_description' => 'The corresponding HMAC for this file does not match',
3770
				);
3771
				continue;
3772
			}
3773
3774
			$_FILES['.jetpack.upload.'] = $file;
3775
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3776
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3777
				$post_id = 0;
3778
			}
3779
3780
			if ( $update_media_item ) {
3781
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3782
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
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...
3783
				}
3784
3785
				$media_array = $_FILES['media'];
3786
3787
				$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...
3788
				$file_array['type']     = $media_array['type'][0];
3789
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3790
				$file_array['error']    = $media_array['error'][0];
3791
				$file_array['size']     = $media_array['size'][0];
3792
3793
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3794
3795
				if ( is_wp_error( $edited_media_item ) ) {
3796
					return $edited_media_item;
3797
				}
3798
3799
				$response = (object) array(
3800
					'id'   => (string) $post_id,
3801
					'file' => (string) $edited_media_item->post_title,
3802
					'url'  => (string) wp_get_attachment_url( $post_id ),
3803
					'type' => (string) $edited_media_item->post_mime_type,
3804
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3805
				);
3806
3807
				return (array) array( $response );
3808
			}
3809
3810
			$attachment_id = media_handle_upload(
3811
				'.jetpack.upload.',
3812
				$post_id,
3813
				array(),
3814
				array(
3815
					'action' => 'jetpack_upload_file',
3816
				)
3817
			);
3818
3819
			if ( ! $attachment_id ) {
3820
				$uploaded_files[ $index ] = (object) array(
3821
					'error'             => 'unknown',
3822
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3823
				);
3824
			} elseif ( is_wp_error( $attachment_id ) ) {
3825
				$uploaded_files[ $index ] = (object) array(
3826
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3827
					'error_description' => $attachment_id->get_error_message(),
3828
				);
3829
			} else {
3830
				$attachment               = get_post( $attachment_id );
3831
				$uploaded_files[ $index ] = (object) array(
3832
					'id'   => (string) $attachment_id,
3833
					'file' => $attachment->post_title,
3834
					'url'  => wp_get_attachment_url( $attachment_id ),
3835
					'type' => $attachment->post_mime_type,
3836
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3837
				);
3838
				// Zip files uploads are not supported unless they are done for installation purposed
3839
				// lets delete them in case something goes wrong in this whole process
3840
				if ( 'application/zip' === $attachment->post_mime_type ) {
3841
					// Schedule a cleanup for 2 hours from now in case of failed install.
3842
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3843
				}
3844
			}
3845
		}
3846
		if ( ! is_null( $global_post ) ) {
3847
			$GLOBALS['post'] = $global_post;
3848
		}
3849
3850
		return $uploaded_files;
3851
	}
3852
3853
	/**
3854
	 * Add help to the Jetpack page
3855
	 *
3856
	 * @since Jetpack (1.2.3)
3857
	 * @return false if not the Jetpack page
3858
	 */
3859
	function admin_help() {
3860
		$current_screen = get_current_screen();
3861
3862
		// Overview
3863
		$current_screen->add_help_tab(
3864
			array(
3865
				'id'      => 'home',
3866
				'title'   => __( 'Home', 'jetpack' ),
3867
				'content' =>
3868
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3869
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3870
					'<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>',
3871
			)
3872
		);
3873
3874
		// Screen Content
3875
		if ( current_user_can( 'manage_options' ) ) {
3876
			$current_screen->add_help_tab(
3877
				array(
3878
					'id'      => 'settings',
3879
					'title'   => __( 'Settings', 'jetpack' ),
3880
					'content' =>
3881
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3882
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3883
						'<ol>' .
3884
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3885
							'<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>' .
3886
						'</ol>' .
3887
						'<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>',
3888
				)
3889
			);
3890
		}
3891
3892
		// Help Sidebar
3893
		$current_screen->set_help_sidebar(
3894
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3895
			'<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3896
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3897
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3898
		);
3899
	}
3900
3901
	function admin_menu_css() {
3902
		wp_enqueue_style( 'jetpack-icons' );
3903
	}
3904
3905
	function admin_menu_order() {
3906
		return true;
3907
	}
3908
3909 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3910
		$jp_menu_order = array();
3911
3912
		foreach ( $menu_order as $index => $item ) {
3913
			if ( $item != 'jetpack' ) {
3914
				$jp_menu_order[] = $item;
3915
			}
3916
3917
			if ( $index == 0 ) {
3918
				$jp_menu_order[] = 'jetpack';
3919
			}
3920
		}
3921
3922
		return $jp_menu_order;
3923
	}
3924
3925
	function admin_banner_styles() {
3926
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3927
3928 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3929
			wp_register_style(
3930
				'jetpack-dops-style',
3931
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3932
				array(),
3933
				JETPACK__VERSION
3934
			);
3935
		}
3936
3937
		wp_enqueue_style(
3938
			'jetpack',
3939
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3940
			array( 'jetpack-dops-style' ),
3941
			JETPACK__VERSION . '-20121016'
3942
		);
3943
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3944
		wp_style_add_data( 'jetpack', 'suffix', $min );
3945
	}
3946
3947
	function plugin_action_links( $actions ) {
3948
3949
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3950
3951
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
3952
			return array_merge(
3953
				$jetpack_home,
3954
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3955
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3956
				$actions
3957
			);
3958
		}
3959
3960
		return array_merge( $jetpack_home, $actions );
3961
	}
3962
3963
	/*
3964
	 * Registration flow:
3965
	 * 1 - ::admin_page_load() action=register
3966
	 * 2 - ::try_registration()
3967
	 * 3 - ::register()
3968
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3969
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3970
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3971
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3972
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3973
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3974
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3975
	 *       jetpack_id, jetpack_secret, jetpack_public
3976
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3977
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3978
	 * 5 - user logs in with WP.com account
3979
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3980
	 *		- Manager::authorize()
3981
	 *		- Manager::get_token()
3982
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3983
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3984
	 *			- which responds with access_token, token_type, scope
3985
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
3986
	 *		- Jetpack::activate_default_modules()
3987
	 *     		- Deactivates deprecated plugins
3988
	 *     		- Activates all default modules
3989
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3990
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3991
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3992
	 *     Done!
3993
	 */
3994
3995
	/**
3996
	 * Handles the page load events for the Jetpack admin page
3997
	 */
3998
	function admin_page_load() {
3999
		$error = false;
4000
4001
		// Make sure we have the right body class to hook stylings for subpages off of.
4002
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4003
4004
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4005
			// Should only be used in intermediate redirects to preserve state across redirects
4006
			self::restate();
4007
		}
4008
4009
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4010
			// @todo: Add validation against a known whitelist
4011
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4012
			// User clicked in the iframe to link their accounts
4013
			if ( ! self::is_user_connected() ) {
4014
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4015
4016
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4017
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4018
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4019
4020
				if ( isset( $_GET['notes_iframe'] ) ) {
4021
					$connect_url .= '&notes_iframe';
4022
				}
4023
				wp_redirect( $connect_url );
4024
				exit;
4025
			} else {
4026
				if ( ! isset( $_GET['calypso_env'] ) ) {
4027
					self::state( 'message', 'already_authorized' );
4028
					wp_safe_redirect( self::admin_url() );
4029
					exit;
4030
				} else {
4031
					$connect_url  = $this->build_connect_url( true, false, $from );
4032
					$connect_url .= '&already_authorized=true';
4033
					wp_redirect( $connect_url );
4034
					exit;
4035
				}
4036
			}
4037
		}
4038
4039
		if ( isset( $_GET['action'] ) ) {
4040
			switch ( $_GET['action'] ) {
4041
				case 'authorize':
4042
					if ( self::is_active() && self::is_user_connected() ) {
4043
						self::state( 'message', 'already_authorized' );
4044
						wp_safe_redirect( self::admin_url() );
4045
						exit;
4046
					}
4047
					self::log( 'authorize' );
4048
					$client_server = new Jetpack_Client_Server();
4049
					$client_server->client_authorize();
4050
					exit;
4051
				case 'register':
4052
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4053
						$error = 'cheatin';
4054
						break;
4055
					}
4056
					check_admin_referer( 'jetpack-register' );
4057
					self::log( 'register' );
4058
					self::maybe_set_version_option();
4059
					$registered = self::try_registration();
4060 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4061
						$error = $registered->get_error_code();
0 ignored issues
show
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...
4062
						self::state( 'error', $error );
4063
						self::state( 'error', $registered->get_error_message() );
0 ignored issues
show
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...
4064
4065
						/**
4066
						 * Jetpack registration Error.
4067
						 *
4068
						 * @since 7.5.0
4069
						 *
4070
						 * @param string|int $error The error code.
4071
						 * @param \WP_Error $registered The error object.
4072
						 */
4073
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4074
						break;
4075
					}
4076
4077
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4078
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4079
4080
					/**
4081
					 * Jetpack registration Success.
4082
					 *
4083
					 * @since 7.5.0
4084
					 *
4085
					 * @param string $from 'from' GET parameter;
4086
					 */
4087
					do_action( 'jetpack_connection_register_success', $from );
4088
4089
					$url = $this->build_connect_url( true, $redirect, $from );
4090
4091
					if ( ! empty( $_GET['onboarding'] ) ) {
4092
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4093
					}
4094
4095
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4096
						$url = add_query_arg( 'auth_approved', 'true', $url );
4097
					}
4098
4099
					wp_redirect( $url );
4100
					exit;
4101
				case 'activate':
4102
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4103
						$error = 'cheatin';
4104
						break;
4105
					}
4106
4107
					$module = stripslashes( $_GET['module'] );
4108
					check_admin_referer( "jetpack_activate-$module" );
4109
					self::log( 'activate', $module );
4110
					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...
4111
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4112
					}
4113
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4114
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4115
					exit;
4116
				case 'activate_default_modules':
4117
					check_admin_referer( 'activate_default_modules' );
4118
					self::log( 'activate_default_modules' );
4119
					self::restate();
4120
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4121
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4122
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4123
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4124
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4125
					exit;
4126
				case 'disconnect':
4127
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4128
						$error = 'cheatin';
4129
						break;
4130
					}
4131
4132
					check_admin_referer( 'jetpack-disconnect' );
4133
					self::log( 'disconnect' );
4134
					self::disconnect();
4135
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4136
					exit;
4137
				case 'reconnect':
4138
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4139
						$error = 'cheatin';
4140
						break;
4141
					}
4142
4143
					check_admin_referer( 'jetpack-reconnect' );
4144
					self::log( 'reconnect' );
4145
					$this->disconnect();
4146
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4147
					exit;
4148 View Code Duplication
				case 'deactivate':
4149
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4150
						$error = 'cheatin';
4151
						break;
4152
					}
4153
4154
					$modules = stripslashes( $_GET['module'] );
4155
					check_admin_referer( "jetpack_deactivate-$modules" );
4156
					foreach ( explode( ',', $modules ) as $module ) {
4157
						self::log( 'deactivate', $module );
4158
						self::deactivate_module( $module );
4159
						self::state( 'message', 'module_deactivated' );
4160
					}
4161
					self::state( 'module', $modules );
4162
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4163
					exit;
4164
				case 'unlink':
4165
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4166
					check_admin_referer( 'jetpack-unlink' );
4167
					self::log( 'unlink' );
4168
					Connection_Manager::disconnect_user();
4169
					self::state( 'message', 'unlinked' );
4170
					if ( 'sub-unlink' == $redirect ) {
4171
						wp_safe_redirect( admin_url() );
4172
					} else {
4173
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4174
					}
4175
					exit;
4176
				case 'onboard':
4177
					if ( ! current_user_can( 'manage_options' ) ) {
4178
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4179
					} else {
4180
						self::create_onboarding_token();
4181
						$url = $this->build_connect_url( true );
4182
4183
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4184
							$url = add_query_arg( 'onboarding', $token, $url );
4185
						}
4186
4187
						$calypso_env = $this->get_calypso_env();
4188
						if ( ! empty( $calypso_env ) ) {
4189
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4190
						}
4191
4192
						wp_redirect( $url );
4193
						exit;
4194
					}
4195
					exit;
4196
				default:
4197
					/**
4198
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4199
					 *
4200
					 * @since 2.6.0
4201
					 *
4202
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4203
					 */
4204
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4205
			}
4206
		}
4207
4208
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4209
			self::activate_new_modules( true );
4210
		}
4211
4212
		$message_code = self::state( 'message' );
4213
		if ( self::state( 'optin-manage' ) ) {
4214
			$activated_manage = $message_code;
4215
			$message_code     = 'jetpack-manage';
4216
		}
4217
4218
		switch ( $message_code ) {
4219
			case 'jetpack-manage':
4220
				$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>';
4221
				if ( $activated_manage ) {
0 ignored issues
show
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...
4222
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4223
				}
4224
				break;
4225
4226
		}
4227
4228
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4229
4230
		if ( ! empty( $deactivated_plugins ) ) {
4231
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4232
			$deactivated_titles  = array();
4233
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4234
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4235
					continue;
4236
				}
4237
4238
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4239
			}
4240
4241
			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...
4242
				if ( $this->message ) {
4243
					$this->message .= "<br /><br />\n";
4244
				}
4245
4246
				$this->message .= wp_sprintf(
4247
					_n(
4248
						'Jetpack contains the most recent version of the old %l plugin.',
4249
						'Jetpack contains the most recent versions of the old %l plugins.',
4250
						count( $deactivated_titles ),
4251
						'jetpack'
4252
					),
4253
					$deactivated_titles
4254
				);
4255
4256
				$this->message .= "<br />\n";
4257
4258
				$this->message .= _n(
4259
					'The old version has been deactivated and can be removed from your site.',
4260
					'The old versions have been deactivated and can be removed from your site.',
4261
					count( $deactivated_titles ),
4262
					'jetpack'
4263
				);
4264
			}
4265
		}
4266
4267
		$this->privacy_checks = self::state( 'privacy_checks' );
4268
4269
		if ( $this->message || $this->error || $this->privacy_checks ) {
4270
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4271
		}
4272
4273
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4274
	}
4275
4276
	function admin_notices() {
4277
4278
		if ( $this->error ) {
4279
			?>
4280
<div id="message" class="jetpack-message jetpack-err">
4281
	<div class="squeezer">
4282
		<h2>
4283
			<?php
4284
			echo wp_kses(
4285
				$this->error,
4286
				array(
4287
					'a'      => array( 'href' => array() ),
4288
					'small'  => true,
4289
					'code'   => true,
4290
					'strong' => true,
4291
					'br'     => true,
4292
					'b'      => true,
4293
				)
4294
			);
4295
			?>
4296
			</h2>
4297
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4298
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4299
<?php	endif; ?>
4300
	</div>
4301
</div>
4302
			<?php
4303
		}
4304
4305
		if ( $this->message ) {
4306
			?>
4307
<div id="message" class="jetpack-message">
4308
	<div class="squeezer">
4309
		<h2>
4310
			<?php
4311
			echo wp_kses(
4312
				$this->message,
4313
				array(
4314
					'strong' => array(),
4315
					'a'      => array( 'href' => true ),
4316
					'br'     => true,
4317
				)
4318
			);
4319
			?>
4320
			</h2>
4321
	</div>
4322
</div>
4323
			<?php
4324
		}
4325
4326
		if ( $this->privacy_checks ) :
4327
			$module_names = $module_slugs = array();
4328
4329
			$privacy_checks = explode( ',', $this->privacy_checks );
4330
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4331
			foreach ( $privacy_checks as $module_slug ) {
4332
				$module = self::get_module( $module_slug );
4333
				if ( ! $module ) {
4334
					continue;
4335
				}
4336
4337
				$module_slugs[] = $module_slug;
4338
				$module_names[] = "<strong>{$module['name']}</strong>";
4339
			}
4340
4341
			$module_slugs = join( ',', $module_slugs );
4342
			?>
4343
<div id="message" class="jetpack-message jetpack-err">
4344
	<div class="squeezer">
4345
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4346
		<p>
4347
			<?php
4348
			echo wp_kses(
4349
				wptexturize(
4350
					wp_sprintf(
4351
						_nx(
4352
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4353
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4354
							count( $privacy_checks ),
4355
							'%l = list of Jetpack module/feature names',
4356
							'jetpack'
4357
						),
4358
						$module_names
4359
					)
4360
				),
4361
				array( 'strong' => true )
4362
			);
4363
4364
			echo "\n<br />\n";
4365
4366
			echo wp_kses(
4367
				sprintf(
4368
					_nx(
4369
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4370
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4371
						count( $privacy_checks ),
4372
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4373
						'jetpack'
4374
					),
4375
					wp_nonce_url(
4376
						self::admin_url(
4377
							array(
4378
								'page'   => 'jetpack',
4379
								'action' => 'deactivate',
4380
								'module' => urlencode( $module_slugs ),
4381
							)
4382
						),
4383
						"jetpack_deactivate-$module_slugs"
4384
					),
4385
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4386
				),
4387
				array(
4388
					'a' => array(
4389
						'href'  => true,
4390
						'title' => true,
4391
					),
4392
				)
4393
			);
4394
			?>
4395
		</p>
4396
	</div>
4397
</div>
4398
			<?php
4399
endif;
4400
	}
4401
4402
	/**
4403
	 * We can't always respond to a signed XML-RPC request with a
4404
	 * helpful error message. In some circumstances, doing so could
4405
	 * leak information.
4406
	 *
4407
	 * Instead, track that the error occurred via a Jetpack_Option,
4408
	 * and send that data back in the heartbeat.
4409
	 * All this does is increment a number, but it's enough to find
4410
	 * trends.
4411
	 *
4412
	 * @param WP_Error $xmlrpc_error The error produced during
4413
	 *                               signature validation.
4414
	 */
4415
	function track_xmlrpc_error( $xmlrpc_error ) {
4416
		$code = is_wp_error( $xmlrpc_error )
4417
			? $xmlrpc_error->get_error_code()
0 ignored issues
show
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...
4418
			: 'should-not-happen';
4419
4420
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4421
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4422
			// No need to update the option if we already have
4423
			// this code stored.
4424
			return;
4425
		}
4426
		$xmlrpc_errors[ $code ] = true;
4427
4428
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
0 ignored issues
show
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...
4429
	}
4430
4431
	/**
4432
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4433
	 */
4434
	function stat( $group, $detail ) {
4435
		if ( ! isset( $this->stats[ $group ] ) ) {
4436
			$this->stats[ $group ] = array();
4437
		}
4438
		$this->stats[ $group ][] = $detail;
4439
	}
4440
4441
	/**
4442
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4443
	 */
4444
	function do_stats( $method = '' ) {
4445
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4446
			foreach ( $this->stats as $group => $stats ) {
4447
				if ( is_array( $stats ) && count( $stats ) ) {
4448
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4449
					if ( 'server_side' === $method ) {
4450
						self::do_server_side_stat( $args );
4451
					} else {
4452
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4453
					}
4454
				}
4455
				unset( $this->stats[ $group ] );
4456
			}
4457
		}
4458
	}
4459
4460
	/**
4461
	 * Runs stats code for a one-off, server-side.
4462
	 *
4463
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4464
	 *
4465
	 * @return bool If it worked.
4466
	 */
4467
	static function do_server_side_stat( $args ) {
4468
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4469
		if ( is_wp_error( $response ) ) {
4470
			return false;
4471
		}
4472
4473
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4474
			return false;
4475
		}
4476
4477
		return true;
4478
	}
4479
4480
	/**
4481
	 * Builds the stats url.
4482
	 *
4483
	 * @param $args array|string The arguments to append to the URL.
4484
	 *
4485
	 * @return string The URL to be pinged.
4486
	 */
4487
	static function build_stats_url( $args ) {
4488
		$defaults = array(
4489
			'v'    => 'wpcom2',
4490
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4491
		);
4492
		$args     = wp_parse_args( $args, $defaults );
4493
		/**
4494
		 * Filter the URL used as the Stats tracking pixel.
4495
		 *
4496
		 * @since 2.3.2
4497
		 *
4498
		 * @param string $url Base URL used as the Stats tracking pixel.
4499
		 */
4500
		$base_url = apply_filters(
4501
			'jetpack_stats_base_url',
4502
			'https://pixel.wp.com/g.gif'
4503
		);
4504
		$url      = add_query_arg( $args, $base_url );
4505
		return $url;
4506
	}
4507
4508
	/**
4509
	 * Get the role of the current user.
4510
	 *
4511
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4512
	 *
4513
	 * @access public
4514
	 * @static
4515
	 *
4516
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4517
	 */
4518
	public static function translate_current_user_to_role() {
4519
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4520
4521
		$roles = new Roles();
4522
		return $roles->translate_current_user_to_role();
4523
	}
4524
4525
	/**
4526
	 * Get the role of a particular user.
4527
	 *
4528
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4529
	 *
4530
	 * @access public
4531
	 * @static
4532
	 *
4533
	 * @param \WP_User $user User object.
4534
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4535
	 */
4536
	public static function translate_user_to_role( $user ) {
4537
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4538
4539
		$roles = new Roles();
4540
		return $roles->translate_user_to_role( $user );
4541
	}
4542
4543
	/**
4544
	 * Get the minimum capability for a role.
4545
	 *
4546
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4547
	 *
4548
	 * @access public
4549
	 * @static
4550
	 *
4551
	 * @param string $role Role name.
4552
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4553
	 */
4554
	public static function translate_role_to_cap( $role ) {
4555
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4556
4557
		$roles = new Roles();
4558
		return $roles->translate_role_to_cap( $role );
4559
	}
4560
4561
	/**
4562
	 * Sign a user role with the master access token.
4563
	 * If not specified, will default to the current user.
4564
	 *
4565
	 * @deprecated since 7.7
4566
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4567
	 *
4568
	 * @access public
4569
	 * @static
4570
	 *
4571
	 * @param string $role    User role.
4572
	 * @param int    $user_id ID of the user.
0 ignored issues
show
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...
4573
	 * @return string Signed user role.
4574
	 */
4575
	public static function sign_role( $role, $user_id = null ) {
4576
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4577
		return self::connection()->sign_role( $role, $user_id );
4578
	}
4579
4580
	/**
4581
	 * Builds a URL to the Jetpack connection auth page
4582
	 *
4583
	 * @since 3.9.5
4584
	 *
4585
	 * @param bool        $raw If true, URL will not be escaped.
4586
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4587
	 *                              If string, will be a custom redirect.
4588
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4589
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4590
	 *
4591
	 * @return string Connect URL
4592
	 */
4593
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4594
		$site_id    = Jetpack_Options::get_option( 'id' );
4595
		$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...
4596
4597
		if ( $register || ! $blog_token || ! $site_id ) {
4598
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4599
4600
			if ( ! empty( $redirect ) ) {
4601
				$url = add_query_arg(
4602
					'redirect',
4603
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4604
					$url
4605
				);
4606
			}
4607
4608
			if ( is_network_admin() ) {
4609
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4610
			}
4611
4612
			$calypso_env = self::get_calypso_env();
4613
4614
			if ( ! empty( $calypso_env ) ) {
4615
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4616
			}
4617
		} else {
4618
4619
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4620
			// because otherwise this logic can get us in to a loop.
4621
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4622
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4623
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4624
4625
				$response = Client::wpcom_json_api_request_as_blog(
4626
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4627
					'1.1'
4628
				);
4629
4630
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4631
4632
					// Generating a register URL instead to refresh the existing token
4633
					return $this->build_connect_url( $raw, $redirect, $from, true );
4634
				}
4635
			}
4636
4637
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
It seems like $redirect defined by parameter $redirect on line 4593 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...
4638
		}
4639
4640
		if ( $from ) {
4641
			$url = add_query_arg( 'from', $from, $url );
4642
		}
4643
4644
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4645
		/**
4646
		 * Filter the URL used when connecting a user to a WordPress.com account.
4647
		 *
4648
		 * @since 8.1.0
4649
		 *
4650
		 * @param string $url Connection URL.
4651
		 * @param bool   $raw If true, URL will not be escaped.
4652
		 */
4653
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4654
	}
4655
4656
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4657
4658
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4659
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4660
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4661
4662
		if ( $iframe ) {
4663
			add_filter( 'jetpack_api_url', array( __CLASS__, 'filter_connect_api_iframe_url' ), 10, 2 );
4664
		}
4665
4666
		$c8n = self::connection();
4667
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
0 ignored issues
show
$redirect is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4668
4669
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4670
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4671
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4672
4673
		if ( $iframe ) {
4674
			remove_filter( 'jetpack_api_url', array( __CLASS__, 'filter_connect_api_iframe_url' ) );
4675
		}
4676
4677
		return $url;
4678
	}
4679
4680
	/**
4681
	 * Filters the connection URL parameter array.
4682
	 *
4683
	 * @param Array $args default URL parameters used by the package.
4684
	 * @return Array the modified URL arguments array.
4685
	 */
4686
	public static function filter_connect_request_body( $args ) {
4687
		if (
4688
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4689
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4690
		) {
4691
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4692
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4693
				? $gp_locale->slug
4694
				: '';
4695
		}
4696
4697
		$tracking        = new Tracking();
4698
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4699
4700
		$args = array_merge(
4701
			$args,
4702
			array(
4703
				'_ui' => $tracks_identity['_ui'],
4704
				'_ut' => $tracks_identity['_ut'],
4705
			)
4706
		);
4707
4708
		$calypso_env = self::get_calypso_env();
4709
4710
		if ( ! empty( $calypso_env ) ) {
4711
			$args['calypso_env'] = $calypso_env;
4712
		}
4713
4714
		return $args;
4715
	}
4716
4717
	/**
4718
	 * Filters the URL that will process the connection data. It can be different from the URL
4719
	 * that we send the user to after everything is done.
4720
	 *
4721
	 * @param String $processing_url the default redirect URL used by the package.
4722
	 * @return String the modified URL.
4723
	 */
4724
	public static function filter_connect_processing_url( $processing_url ) {
4725
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4726
		return $processing_url;
4727
	}
4728
4729
	/**
4730
	 * Filters the redirection URL that is used for connect requests. The redirect
4731
	 * URL should return the user back to the Jetpack console.
4732
	 *
4733
	 * @param String $redirect the default redirect URL used by the package.
4734
	 * @return String the modified URL.
4735
	 */
4736
	public static function filter_connect_redirect_url( $redirect ) {
4737
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4738
		$redirect           = $redirect
4739
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4740
			: $jetpack_admin_page;
4741
4742
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4743
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4744
		}
4745
4746
		return $redirect;
4747
	}
4748
4749
	/**
4750
	 * Filters the API URL that is used for connect requests. The method
4751
	 * intercepts only the authorize URL and replaces it with another if needed.
4752
	 *
4753
	 * @param String $api_url the default redirect API URL used by the package.
4754
	 * @param String $relative_url the path of the URL that's being used.
4755
	 * @return String the modified URL.
4756
	 */
4757
	public static function filter_connect_api_iframe_url( $api_url, $relative_url ) {
4758
4759
		// Short-circuit on anything that is not related to connect requests.
4760
		if ( 'authorize' !== $relative_url ) {
4761
			return $api_url;
4762
		}
4763
4764
		$c8n = self::connection();
4765
4766
		return $c8n->api_url( 'authorize_iframe' );
4767
	}
4768
4769
	/**
4770
	 * This action fires at the beginning of the Manager::authorize method.
4771
	 */
4772
	public static function authorize_starting() {
4773
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4774
		// Checking if site has been active/connected previously before recording unique connection.
4775
		if ( ! $jetpack_unique_connection ) {
4776
			// jetpack_unique_connection option has never been set.
4777
			$jetpack_unique_connection = array(
4778
				'connected'    => 0,
4779
				'disconnected' => 0,
4780
				'version'      => '3.6.1',
4781
			);
4782
4783
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4784
4785
			// Track unique connection.
4786
			$jetpack = self::init();
4787
4788
			$jetpack->stat( 'connections', 'unique-connection' );
4789
			$jetpack->do_stats( 'server_side' );
4790
		}
4791
4792
		// Increment number of times connected.
4793
		$jetpack_unique_connection['connected'] += 1;
4794
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4795
	}
4796
4797
	/**
4798
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4799
	 * linked.
4800
	 */
4801
	public static function authorize_ending_linked() {
4802
		// Don't activate anything since we are just connecting a user.
4803
		self::state( 'message', 'linked' );
4804
	}
4805
4806
	/**
4807
	 * This action fires at the end of the Manager::authorize method when the master user is
4808
	 * authorized.
4809
	 *
4810
	 * @param array $data The request data.
4811
	 */
4812
	public static function authorize_ending_authorized( $data ) {
4813
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4814
		self::invalidate_onboarding_token();
4815
4816
		// If redirect_uri is SSO, ensure SSO module is enabled.
4817
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
4818
4819
		/** This filter is documented in class.jetpack-cli.php */
4820
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4821
4822
		$activate_sso = (
4823
			isset( $redirect_options['action'] ) &&
4824
			'jetpack-sso' === $redirect_options['action'] &&
4825
			$jetpack_start_enable_sso
4826
		);
4827
4828
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4829
4830
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4831
	}
4832
4833
	/**
4834
	 * Get our assumed site creation date.
4835
	 * Calculated based on the earlier date of either:
4836
	 * - Earliest admin user registration date.
4837
	 * - Earliest date of post of any post type.
4838
	 *
4839
	 * @since 7.2.0
4840
	 * @deprecated since 7.8.0
4841
	 *
4842
	 * @return string Assumed site creation date and time.
4843
	 */
4844
	public static function get_assumed_site_creation_date() {
4845
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4846
		return self::connection()->get_assumed_site_creation_date();
4847
	}
4848
4849 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4850
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4851
4852
		if ( $activation_source_name ) {
4853
			$args['_as'] = urlencode( $activation_source_name );
4854
		}
4855
4856
		if ( $activation_source_keyword ) {
4857
			$args['_ak'] = urlencode( $activation_source_keyword );
4858
		}
4859
	}
4860
4861
	function build_reconnect_url( $raw = false ) {
4862
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4863
		return $raw ? $url : esc_url( $url );
4864
	}
4865
4866
	public static function admin_url( $args = null ) {
4867
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4868
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4869
		return $url;
4870
	}
4871
4872
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4873
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4874
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4875
	}
4876
4877
	function dismiss_jetpack_notice() {
4878
4879
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4880
			return;
4881
		}
4882
4883
		switch ( $_GET['jetpack-notice'] ) {
4884
			case 'dismiss':
4885
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4886
4887
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4888
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4889
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4890
				}
4891
				break;
4892
		}
4893
	}
4894
4895
	public static function sort_modules( $a, $b ) {
4896
		if ( $a['sort'] == $b['sort'] ) {
4897
			return 0;
4898
		}
4899
4900
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4901
	}
4902
4903
	function ajax_recheck_ssl() {
4904
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4905
		$result = self::permit_ssl( true );
4906
		wp_send_json(
4907
			array(
4908
				'enabled' => $result,
4909
				'message' => get_transient( 'jetpack_https_test_message' ),
4910
			)
4911
		);
4912
	}
4913
4914
	/* Client API */
4915
4916
	/**
4917
	 * Returns the requested Jetpack API URL
4918
	 *
4919
	 * @deprecated since 7.7
4920
	 * @return string
4921
	 */
4922
	public static function api_url( $relative_url ) {
4923
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
4924
		$connection = self::connection();
4925
		return $connection->api_url( $relative_url );
4926
	}
4927
4928
	/**
4929
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
4930
	 *
4931
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4932
	 */
4933
	public static function fix_url_for_bad_hosts( $url ) {
4934
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
4935
		return Connection_Utils::fix_url_for_bad_hosts( $url );
4936
	}
4937
4938
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
4939
		// Default to a blog token.
4940
		$token_type = 'blog';
4941
4942
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
4943
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
4944
			if ( ! empty( $_GET['onboarding'] ) ) {
4945
				$jpo = $_GET;
4946
			} else {
4947
				$jpo = json_decode( $request_data, true );
4948
			}
4949
4950
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
4951
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
4952
4953
			if (
4954
				isset( $jpo_user )
4955
				&& isset( $jpo_token )
4956
				&& is_email( $jpo_user )
4957
				&& ctype_alnum( $jpo_token )
4958
				&& isset( $_GET['rest_route'] )
4959
				&& self::validate_onboarding_token_action(
4960
					$jpo_token,
4961
					$_GET['rest_route']
4962
				)
4963
			) {
4964
				$jp_user = get_user_by( 'email', $jpo_user );
4965
				if ( is_a( $jp_user, 'WP_User' ) ) {
4966
					wp_set_current_user( $jp_user->ID );
4967
					$user_can = is_multisite()
4968
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
4969
						: current_user_can( 'manage_options' );
4970
					if ( $user_can ) {
4971
						$token_type              = 'user';
4972
						$token->external_user_id = $jp_user->ID;
4973
					}
4974
				}
4975
			}
4976
4977
			$token_data['type']    = $token_type;
4978
			$token_data['user_id'] = $token->external_user_id;
4979
		}
4980
4981
		return $token_data;
4982
	}
4983
4984
	/**
4985
	 * Create a random secret for validating onboarding payload
4986
	 *
4987
	 * @return string Secret token
4988
	 */
4989
	public static function create_onboarding_token() {
4990
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4991
			$token = wp_generate_password( 32, false );
4992
			Jetpack_Options::update_option( 'onboarding', $token );
4993
		}
4994
4995
		return $token;
4996
	}
4997
4998
	/**
4999
	 * Remove the onboarding token
5000
	 *
5001
	 * @return bool True on success, false on failure
5002
	 */
5003
	public static function invalidate_onboarding_token() {
5004
		return Jetpack_Options::delete_option( 'onboarding' );
5005
	}
5006
5007
	/**
5008
	 * Validate an onboarding token for a specific action
5009
	 *
5010
	 * @return boolean True if token/action pair is accepted, false if not
5011
	 */
5012
	public static function validate_onboarding_token_action( $token, $action ) {
5013
		// Compare tokens, bail if tokens do not match
5014
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5015
			return false;
5016
		}
5017
5018
		// List of valid actions we can take
5019
		$valid_actions = array(
5020
			'/jetpack/v4/settings',
5021
		);
5022
5023
		// Whitelist the action
5024
		if ( ! in_array( $action, $valid_actions ) ) {
5025
			return false;
5026
		}
5027
5028
		return true;
5029
	}
5030
5031
	/**
5032
	 * Checks to see if the URL is using SSL to connect with Jetpack
5033
	 *
5034
	 * @since 2.3.3
5035
	 * @return boolean
5036
	 */
5037
	public static function permit_ssl( $force_recheck = false ) {
5038
		// Do some fancy tests to see if ssl is being supported
5039
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5040
			$message = '';
5041
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5042
				$ssl = 0;
5043
			} else {
5044
				switch ( JETPACK_CLIENT__HTTPS ) {
5045
					case 'NEVER':
5046
						$ssl     = 0;
5047
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5048
						break;
5049
					case 'ALWAYS':
5050
					case 'AUTO':
5051
					default:
5052
						$ssl = 1;
5053
						break;
5054
				}
5055
5056
				// If it's not 'NEVER', test to see
5057
				if ( $ssl ) {
5058
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5059
						$ssl     = 0;
5060
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5061
					} else {
5062
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5063
						if ( is_wp_error( $response ) ) {
5064
							$ssl     = 0;
5065
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5066
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5067
							$ssl     = 0;
5068
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5069
						}
5070
					}
5071
				}
5072
			}
5073
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5074
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5075
		}
5076
5077
		return (bool) $ssl;
5078
	}
5079
5080
	/*
5081
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5082
	 */
5083
	public function alert_auto_ssl_fail() {
5084
		if ( ! current_user_can( 'manage_options' ) ) {
5085
			return;
5086
		}
5087
5088
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5089
		?>
5090
5091
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5092
			<div class="jp-banner__content">
5093
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5094
				<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>
5095
				<p>
5096
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5097
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5098
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5099
				</p>
5100
				<p>
5101
					<?php
5102
					printf(
5103
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5104
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5105
						esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' )
5106
					);
5107
					?>
5108
				</p>
5109
			</div>
5110
		</div>
5111
		<style>
5112
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5113
		</style>
5114
		<script type="text/javascript">
5115
			jQuery( document ).ready( function( $ ) {
5116
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5117
					var $this = $( this );
5118
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5119
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5120
					e.preventDefault();
5121
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5122
					$.post( ajaxurl, data )
5123
					  .done( function( response ) {
5124
						  if ( response.enabled ) {
5125
							  $( '#jetpack-ssl-warning' ).hide();
5126
						  } else {
5127
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5128
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5129
						  }
5130
					  }.bind( $this ) );
5131
				} );
5132
			} );
5133
		</script>
5134
5135
		<?php
5136
	}
5137
5138
	/**
5139
	 * Returns the Jetpack XML-RPC API
5140
	 *
5141
	 * @deprecated 8.0 Use Connection_Manager instead.
5142
	 * @return string
5143
	 */
5144
	public static function xmlrpc_api_url() {
5145
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5146
		return self::connection()->xmlrpc_api_url();
5147
	}
5148
5149
	/**
5150
	 * Returns the connection manager object.
5151
	 *
5152
	 * @return Automattic\Jetpack\Connection\Manager
5153
	 */
5154
	public static function connection() {
5155
		return self::init()->connection_manager;
5156
	}
5157
5158
	/**
5159
	 * Creates two secret tokens and the end of life timestamp for them.
5160
	 *
5161
	 * Note these tokens are unique per call, NOT static per site for connecting.
5162
	 *
5163
	 * @since 2.6
5164
	 * @param String  $action  The action name.
5165
	 * @param Integer $user_id The user identifier.
0 ignored issues
show
Should the type for parameter $user_id not be false|integer?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5166
	 * @param Integer $exp     Expiration time in seconds.
5167
	 * @return array
5168
	 */
5169
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5170
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5171
	}
5172
5173
	public static function get_secrets( $action, $user_id ) {
5174
		$secrets = self::connection()->get_secrets( $action, $user_id );
5175
5176
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5177
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
0 ignored issues
show
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...
5178
		}
5179
5180
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5181
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
0 ignored issues
show
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...
5182
		}
5183
5184
		return $secrets;
5185
	}
5186
5187
	/**
5188
	 * @deprecated 7.5 Use Connection_Manager instead.
5189
	 *
5190
	 * @param $action
5191
	 * @param $user_id
5192
	 */
5193
	public static function delete_secrets( $action, $user_id ) {
5194
		return self::connection()->delete_secrets( $action, $user_id );
5195
	}
5196
5197
	/**
5198
	 * Builds the timeout limit for queries talking with the wpcom servers.
5199
	 *
5200
	 * Based on local php max_execution_time in php.ini
5201
	 *
5202
	 * @since 2.6
5203
	 * @return int
5204
	 * @deprecated
5205
	 **/
5206
	public function get_remote_query_timeout_limit() {
5207
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5208
		return self::get_max_execution_time();
5209
	}
5210
5211
	/**
5212
	 * Builds the timeout limit for queries talking with the wpcom servers.
5213
	 *
5214
	 * Based on local php max_execution_time in php.ini
5215
	 *
5216
	 * @since 5.4
5217
	 * @return int
5218
	 **/
5219
	public static function get_max_execution_time() {
5220
		$timeout = (int) ini_get( 'max_execution_time' );
5221
5222
		// Ensure exec time set in php.ini
5223
		if ( ! $timeout ) {
5224
			$timeout = 30;
5225
		}
5226
		return $timeout;
5227
	}
5228
5229
	/**
5230
	 * Sets a minimum request timeout, and returns the current timeout
5231
	 *
5232
	 * @since 5.4
5233
	 **/
5234 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5235
		$timeout = self::get_max_execution_time();
5236
		if ( $timeout < $min_timeout ) {
5237
			$timeout = $min_timeout;
5238
			set_time_limit( $timeout );
5239
		}
5240
		return $timeout;
5241
	}
5242
5243
	/**
5244
	 * Takes the response from the Jetpack register new site endpoint and
5245
	 * verifies it worked properly.
5246
	 *
5247
	 * @since 2.6
5248
	 * @deprecated since 7.7.0
5249
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5250
	 **/
5251
	public function validate_remote_register_response() {
5252
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5253
	}
5254
5255
	/**
5256
	 * @return bool|WP_Error
5257
	 */
5258
	public static function register() {
5259
		$tracking = new Tracking();
5260
		$tracking->record_user_event( 'jpc_register_begin' );
5261
5262
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5263
5264
		$connection   = self::connection();
5265
		$registration = $connection->register();
5266
5267
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5268
5269
		if ( ! $registration || is_wp_error( $registration ) ) {
5270
			return $registration;
5271
		}
5272
5273
		return true;
5274
	}
5275
5276
	/**
5277
	 * Filters the registration request body to include tracking properties.
5278
	 *
5279
	 * @param Array $properties
5280
	 * @return Array amended properties.
5281
	 */
5282 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5283
		$tracking        = new Tracking();
5284
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5285
5286
		return array_merge(
5287
			$properties,
5288
			array(
5289
				'_ui' => $tracks_identity['_ui'],
5290
				'_ut' => $tracks_identity['_ut'],
5291
			)
5292
		);
5293
	}
5294
5295
	/**
5296
	 * Filters the token request body to include tracking properties.
5297
	 *
5298
	 * @param Array $properties
5299
	 * @return Array amended properties.
5300
	 */
5301 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5302
		$tracking        = new Tracking();
5303
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5304
5305
		return array_merge(
5306
			$properties,
5307
			array(
5308
				'_ui' => $tracks_identity['_ui'],
5309
				'_ut' => $tracks_identity['_ut'],
5310
			)
5311
		);
5312
	}
5313
5314
	/**
5315
	 * If the db version is showing something other that what we've got now, bump it to current.
5316
	 *
5317
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
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...
5318
	 */
5319
	public static function maybe_set_version_option() {
5320
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5321
		if ( JETPACK__VERSION != $version ) {
5322
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5323
5324
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5325
				/** This action is documented in class.jetpack.php */
5326
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5327
			}
5328
5329
			return true;
5330
		}
5331
		return false;
5332
	}
5333
5334
	/* Client Server API */
5335
5336
	/**
5337
	 * Loads the Jetpack XML-RPC client.
5338
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5339
	 *
5340
	 * @deprecated since 7.7.0
5341
	 */
5342
	public static function load_xml_rpc_client() {
5343
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5344
	}
5345
5346
	/**
5347
	 * Resets the saved authentication state in between testing requests.
5348
	 */
5349
	public function reset_saved_auth_state() {
5350
		$this->rest_authentication_status = null;
5351
		$this->connection_manager->reset_saved_auth_state();
5352
	}
5353
5354
	/**
5355
	 * Verifies the signature of the current request.
5356
	 *
5357
	 * @deprecated since 7.7.0
5358
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5359
	 *
5360
	 * @return false|array
5361
	 */
5362
	public function verify_xml_rpc_signature() {
5363
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5364
		return self::connection()->verify_xml_rpc_signature();
5365
	}
5366
5367
	/**
5368
	 * Verifies the signature of the current request.
5369
	 *
5370
	 * This function has side effects and should not be used. Instead,
5371
	 * use the memoized version `->verify_xml_rpc_signature()`.
5372
	 *
5373
	 * @deprecated since 7.7.0
5374
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5375
	 * @internal
5376
	 */
5377
	private function internal_verify_xml_rpc_signature() {
5378
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5379
	}
5380
5381
	/**
5382
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5383
	 *
5384
	 * @deprecated since 7.7.0
5385
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5386
	 *
5387
	 * @param \WP_User|mixed $user     User object if authenticated.
5388
	 * @param string         $username Username.
5389
	 * @param string         $password Password string.
5390
	 * @return \WP_User|mixed Authenticated user or error.
5391
	 */
5392
	public function authenticate_jetpack( $user, $username, $password ) {
5393
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5394
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5395
	}
5396
5397
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5398
	// Uses the existing XMLRPC request signing implementation.
5399
	function wp_rest_authenticate( $user ) {
5400
		if ( ! empty( $user ) ) {
5401
			// Another authentication method is in effect.
5402
			return $user;
5403
		}
5404
5405
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5406
			// Nothing to do for this authentication method.
5407
			return null;
5408
		}
5409
5410
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5411
			// Nothing to do for this authentication method.
5412
			return null;
5413
		}
5414
5415
		// Ensure that we always have the request body available.  At this
5416
		// point, the WP REST API code to determine the request body has not
5417
		// run yet.  That code may try to read from 'php://input' later, but
5418
		// this can only be done once per request in PHP versions prior to 5.6.
5419
		// So we will go ahead and perform this read now if needed, and save
5420
		// the request body where both the Jetpack signature verification code
5421
		// and the WP REST API code can see it.
5422
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5423
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5424
		}
5425
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5426
5427
		// Only support specific request parameters that have been tested and
5428
		// are known to work with signature verification.  A different method
5429
		// can be passed to the WP REST API via the '?_method=' parameter if
5430
		// needed.
5431
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5432
			$this->rest_authentication_status = new WP_Error(
5433
				'rest_invalid_request',
0 ignored issues
show
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...
5434
				__( 'This request method is not supported.', 'jetpack' ),
5435
				array( 'status' => 400 )
5436
			);
5437
			return null;
5438
		}
5439
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5440
			$this->rest_authentication_status = new WP_Error(
5441
				'rest_invalid_request',
0 ignored issues
show
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...
5442
				__( 'This request method does not support body parameters.', 'jetpack' ),
5443
				array( 'status' => 400 )
5444
			);
5445
			return null;
5446
		}
5447
5448
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5449
5450
		if (
5451
			$verified &&
5452
			isset( $verified['type'] ) &&
5453
			'user' === $verified['type'] &&
5454
			! empty( $verified['user_id'] )
5455
		) {
5456
			// Authentication successful.
5457
			$this->rest_authentication_status = true;
5458
			return $verified['user_id'];
5459
		}
5460
5461
		// Something else went wrong.  Probably a signature error.
5462
		$this->rest_authentication_status = new WP_Error(
5463
			'rest_invalid_signature',
0 ignored issues
show
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...
5464
			__( 'The request is not signed correctly.', 'jetpack' ),
5465
			array( 'status' => 400 )
5466
		);
5467
		return null;
5468
	}
5469
5470
	/**
5471
	 * Report authentication status to the WP REST API.
5472
	 *
5473
	 * @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
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...
5474
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5475
	 */
5476
	public function wp_rest_authentication_errors( $value ) {
5477
		if ( $value !== null ) {
5478
			return $value;
5479
		}
5480
		return $this->rest_authentication_status;
5481
	}
5482
5483
	/**
5484
	 * Add our nonce to this request.
5485
	 *
5486
	 * @deprecated since 7.7.0
5487
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5488
	 *
5489
	 * @param int    $timestamp Timestamp of the request.
5490
	 * @param string $nonce     Nonce string.
5491
	 */
5492
	public function add_nonce( $timestamp, $nonce ) {
5493
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5494
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5495
	}
5496
5497
	/**
5498
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5499
	 * Capture it here so we can verify the signature later.
5500
	 *
5501
	 * @deprecated since 7.7.0
5502
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5503
	 *
5504
	 * @param array $methods XMLRPC methods.
5505
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5506
	 */
5507
	public function xmlrpc_methods( $methods ) {
5508
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5509
		return $this->connection_manager->xmlrpc_methods( $methods );
5510
	}
5511
5512
	/**
5513
	 * Register additional public XMLRPC methods.
5514
	 *
5515
	 * @deprecated since 7.7.0
5516
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5517
	 *
5518
	 * @param array $methods Public XMLRPC methods.
5519
	 * @return array Public XMLRPC methods, with the getOptions one.
5520
	 */
5521
	public function public_xmlrpc_methods( $methods ) {
5522
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5523
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5524
	}
5525
5526
	/**
5527
	 * Handles a getOptions XMLRPC method call.
5528
	 *
5529
	 * @deprecated since 7.7.0
5530
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5531
	 *
5532
	 * @param array $args method call arguments.
5533
	 * @return array an amended XMLRPC server options array.
5534
	 */
5535
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5536
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5537
		return $this->connection_manager->jetpack_getOptions( $args );
0 ignored issues
show
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...
5538
	}
5539
5540
	/**
5541
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5542
	 *
5543
	 * @deprecated since 7.7.0
5544
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5545
	 *
5546
	 * @param array $options Standard Core options.
5547
	 * @return array Amended options.
5548
	 */
5549
	public function xmlrpc_options( $options ) {
5550
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5551
		return $this->connection_manager->xmlrpc_options( $options );
5552
	}
5553
5554
	/**
5555
	 * Cleans nonces that were saved when calling ::add_nonce.
5556
	 *
5557
	 * @deprecated since 7.7.0
5558
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5559
	 *
5560
	 * @param bool $all whether to clean even non-expired nonces.
5561
	 */
5562
	public static function clean_nonces( $all = false ) {
5563
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5564
		return self::connection()->clean_nonces( $all );
5565
	}
5566
5567
	/**
5568
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5569
	 * SET: state( $key, $value );
5570
	 * GET: $value = state( $key );
5571
	 *
5572
	 * @param string $key
0 ignored issues
show
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...
5573
	 * @param string $value
0 ignored issues
show
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...
5574
	 * @param bool   $restate private
5575
	 */
5576
	public static function state( $key = null, $value = null, $restate = false ) {
5577
		static $state = array();
5578
		static $path, $domain;
5579
		if ( ! isset( $path ) ) {
5580
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5581
			$admin_url = self::admin_url();
5582
			$bits      = wp_parse_url( $admin_url );
5583
5584
			if ( is_array( $bits ) ) {
5585
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5586
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5587
			} else {
5588
				$path = $domain = null;
5589
			}
5590
		}
5591
5592
		// Extract state from cookies and delete cookies
5593
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5594
			$yum = $_COOKIE['jetpackState'];
5595
			unset( $_COOKIE['jetpackState'] );
5596
			foreach ( $yum as $k => $v ) {
5597
				if ( strlen( $v ) ) {
5598
					$state[ $k ] = $v;
5599
				}
5600
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5601
			}
5602
		}
5603
5604
		if ( $restate ) {
5605
			foreach ( $state as $k => $v ) {
5606
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5607
			}
5608
			return;
5609
		}
5610
5611
		// Get a state variable
5612
		if ( isset( $key ) && ! isset( $value ) ) {
5613
			if ( array_key_exists( $key, $state ) ) {
5614
				return $state[ $key ];
5615
			}
5616
			return null;
5617
		}
5618
5619
		// Set a state variable
5620
		if ( isset( $key ) && isset( $value ) ) {
5621
			if ( is_array( $value ) && isset( $value[0] ) ) {
5622
				$value = $value[0];
5623
			}
5624
			$state[ $key ] = $value;
5625
			if ( ! headers_sent() ) {
5626
				setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5627
			}
5628
		}
5629
	}
5630
5631
	public static function restate() {
5632
		self::state( null, null, true );
5633
	}
5634
5635
	public static function check_privacy( $file ) {
5636
		static $is_site_publicly_accessible = null;
5637
5638
		if ( is_null( $is_site_publicly_accessible ) ) {
5639
			$is_site_publicly_accessible = false;
5640
5641
			$rpc = new Jetpack_IXR_Client();
5642
5643
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5644
			if ( $success ) {
5645
				$response = $rpc->getResponse();
5646
				if ( $response ) {
5647
					$is_site_publicly_accessible = true;
5648
				}
5649
			}
5650
5651
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5652
		}
5653
5654
		if ( $is_site_publicly_accessible ) {
5655
			return;
5656
		}
5657
5658
		$module_slug = self::get_module_slug( $file );
5659
5660
		$privacy_checks = self::state( 'privacy_checks' );
5661
		if ( ! $privacy_checks ) {
5662
			$privacy_checks = $module_slug;
5663
		} else {
5664
			$privacy_checks .= ",$module_slug";
5665
		}
5666
5667
		self::state( 'privacy_checks', $privacy_checks );
5668
	}
5669
5670
	/**
5671
	 * Helper method for multicall XMLRPC.
5672
	 *
5673
	 * @param ...$args Args for the async_call.
5674
	 */
5675
	public static function xmlrpc_async_call( ...$args ) {
5676
		global $blog_id;
5677
		static $clients = array();
5678
5679
		$client_blog_id = is_multisite() ? $blog_id : 0;
5680
5681
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5682
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5683
			if ( function_exists( 'ignore_user_abort' ) ) {
5684
				ignore_user_abort( true );
5685
			}
5686
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5687
		}
5688
5689
		if ( ! empty( $args[0] ) ) {
5690
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5691
		} elseif ( is_multisite() ) {
5692
			foreach ( $clients as $client_blog_id => $client ) {
5693
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5694
					continue;
5695
				}
5696
5697
				$switch_success = switch_to_blog( $client_blog_id, true );
5698
				if ( ! $switch_success ) {
5699
					continue;
5700
				}
5701
5702
				flush();
5703
				$client->query();
5704
5705
				restore_current_blog();
5706
			}
5707
		} else {
5708
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5709
				flush();
5710
				$clients[0]->query();
5711
			}
5712
		}
5713
	}
5714
5715
	public static function staticize_subdomain( $url ) {
5716
5717
		// Extract hostname from URL
5718
		$host = wp_parse_url( $url, PHP_URL_HOST );
5719
5720
		// Explode hostname on '.'
5721
		$exploded_host = explode( '.', $host );
5722
5723
		// Retrieve the name and TLD
5724
		if ( count( $exploded_host ) > 1 ) {
5725
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5726
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5727
			// Rebuild domain excluding subdomains
5728
			$domain = $name . '.' . $tld;
5729
		} else {
5730
			$domain = $host;
5731
		}
5732
		// Array of Automattic domains
5733
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5734
5735
		// Return $url if not an Automattic domain
5736
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5737
			return $url;
5738
		}
5739
5740
		if ( is_ssl() ) {
5741
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5742
		}
5743
5744
		srand( crc32( basename( $url ) ) );
5745
		$static_counter = rand( 0, 2 );
5746
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5747
5748
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5749
	}
5750
5751
	/* JSON API Authorization */
5752
5753
	/**
5754
	 * Handles the login action for Authorizing the JSON API
5755
	 */
5756
	function login_form_json_api_authorization() {
5757
		$this->verify_json_api_authorization_request();
5758
5759
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5760
5761
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5762
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5763
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5764
	}
5765
5766
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5767
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5768
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5769
			return $url;
5770
		}
5771
5772
		$parsed_url = wp_parse_url( $url );
5773
		$url        = strtok( $url, '?' );
5774
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5775
		if ( ! empty( $parsed_url['query'] ) ) {
5776
			$url .= "&{$parsed_url['query']}";
5777
		}
5778
5779
		return $url;
5780
	}
5781
5782
	// Make sure the POSTed request is handled by the same action
5783
	function preserve_action_in_login_form_for_json_api_authorization() {
5784
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5785
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5786
	}
5787
5788
	// If someone logs in to approve API access, store the Access Code in usermeta
5789
	function store_json_api_authorization_token( $user_login, $user ) {
5790
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5791
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5792
		$token = wp_generate_password( 32, false );
5793
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5794
	}
5795
5796
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5797
	function allow_wpcom_public_api_domain( $domains ) {
5798
		$domains[] = 'public-api.wordpress.com';
5799
		return $domains;
5800
	}
5801
5802
	static function is_redirect_encoded( $redirect_url ) {
5803
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5804
	}
5805
5806
	// Add all wordpress.com environments to the safe redirect whitelist
5807
	function allow_wpcom_environments( $domains ) {
5808
		$domains[] = 'wordpress.com';
5809
		$domains[] = 'wpcalypso.wordpress.com';
5810
		$domains[] = 'horizon.wordpress.com';
5811
		$domains[] = 'calypso.localhost';
5812
		return $domains;
5813
	}
5814
5815
	// Add the Access Code details to the public-api.wordpress.com redirect
5816
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5817
		return add_query_arg(
5818
			urlencode_deep(
5819
				array(
5820
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5821
					'jetpack-user-id' => (int) $user->ID,
5822
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5823
				)
5824
			),
5825
			$redirect_to
5826
		);
5827
	}
5828
5829
5830
	/**
5831
	 * Verifies the request by checking the signature
5832
	 *
5833
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5834
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5835
	 *
5836
	 * @param null|array $environment
5837
	 */
5838
	function verify_json_api_authorization_request( $environment = null ) {
5839
		$environment = is_null( $environment )
5840
			? $_REQUEST
5841
			: $environment;
5842
5843
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
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...
5844
		$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...
5845
		if ( ! $token || empty( $token->secret ) ) {
5846
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5847
		}
5848
5849
		$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' );
5850
5851
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5852
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5853
			/**
5854
			 * Jetpack authorisation request Error.
5855
			 *
5856
			 * @since 7.5.0
5857
			 */
5858
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5859
			$die_error = sprintf(
5860
				/* translators: %s is a URL */
5861
				__( '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' ),
5862
				'https://jetpack.com/support/double-encoding/'
5863
			);
5864
		}
5865
5866
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5867
5868
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5869
			$signature = $jetpack_signature->sign_request(
5870
				$environment['token'],
5871
				$environment['timestamp'],
5872
				$environment['nonce'],
5873
				'',
5874
				'GET',
5875
				$environment['jetpack_json_api_original_query'],
5876
				null,
5877
				true
5878
			);
5879
		} else {
5880
			$signature = $jetpack_signature->sign_current_request(
5881
				array(
5882
					'body'   => null,
5883
					'method' => 'GET',
5884
				)
5885
			);
5886
		}
5887
5888
		if ( ! $signature ) {
5889
			wp_die( $die_error );
5890
		} elseif ( is_wp_error( $signature ) ) {
5891
			wp_die( $die_error );
5892
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
5893
			if ( is_ssl() ) {
5894
				// 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
5895
				$signature = $jetpack_signature->sign_current_request(
5896
					array(
5897
						'scheme' => 'http',
5898
						'body'   => null,
5899
						'method' => 'GET',
5900
					)
5901
				);
5902
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5903
					wp_die( $die_error );
5904
				}
5905
			} else {
5906
				wp_die( $die_error );
5907
			}
5908
		}
5909
5910
		$timestamp = (int) $environment['timestamp'];
5911
		$nonce     = stripslashes( (string) $environment['nonce'] );
5912
5913
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
5914
			// De-nonce the nonce, at least for 5 minutes.
5915
			// 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)
5916
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5917
			if ( $old_nonce_time < time() - 300 ) {
5918
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
5919
			}
5920
		}
5921
5922
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5923
		$data_filters = array(
5924
			'state'        => 'opaque',
5925
			'client_id'    => 'int',
5926
			'client_title' => 'string',
5927
			'client_image' => 'url',
5928
		);
5929
5930
		foreach ( $data_filters as $key => $sanitation ) {
5931
			if ( ! isset( $data->$key ) ) {
5932
				wp_die( $die_error );
5933
			}
5934
5935
			switch ( $sanitation ) {
5936
				case 'int':
5937
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
5938
					break;
5939
				case 'opaque':
5940
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
5941
					break;
5942
				case 'string':
5943
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
5944
					break;
5945
				case 'url':
5946
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
5947
					break;
5948
			}
5949
		}
5950
5951
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5952
			wp_die( $die_error );
5953
		}
5954
	}
5955
5956
	function login_message_json_api_authorization( $message ) {
5957
		return '<p class="message">' . sprintf(
5958
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
5959
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5960
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5961
	}
5962
5963
	/**
5964
	 * Get $content_width, but with a <s>twist</s> filter.
5965
	 */
5966
	public static function get_content_width() {
5967
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5968
			? $GLOBALS['content_width']
5969
			: false;
5970
		/**
5971
		 * Filter the Content Width value.
5972
		 *
5973
		 * @since 2.2.3
5974
		 *
5975
		 * @param string $content_width Content Width value.
5976
		 */
5977
		return apply_filters( 'jetpack_content_width', $content_width );
5978
	}
5979
5980
	/**
5981
	 * Pings the WordPress.com Mirror Site for the specified options.
5982
	 *
5983
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5984
	 *
5985
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5986
	 */
5987
	public function get_cloud_site_options( $option_names ) {
5988
		$option_names = array_filter( (array) $option_names, 'is_string' );
5989
5990
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
5991
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5992
		if ( $xml->isError() ) {
5993
			return array(
5994
				'error_code' => $xml->getErrorCode(),
5995
				'error_msg'  => $xml->getErrorMessage(),
5996
			);
5997
		}
5998
		$cloud_site_options = $xml->getResponse();
5999
6000
		return $cloud_site_options;
6001
	}
6002
6003
	/**
6004
	 * Checks if the site is currently in an identity crisis.
6005
	 *
6006
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6007
	 */
6008
	public static function check_identity_crisis() {
6009
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6010
			return false;
6011
		}
6012
6013
		return Jetpack_Options::get_option( 'sync_error_idc' );
6014
	}
6015
6016
	/**
6017
	 * Checks whether the home and siteurl specifically are whitelisted
6018
	 * Written so that we don't have re-check $key and $value params every time
6019
	 * we want to check if this site is whitelisted, for example in footer.php
6020
	 *
6021
	 * @since  3.8.0
6022
	 * @return bool True = already whitelisted False = not whitelisted
6023
	 */
6024
	public static function is_staging_site() {
6025
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6026
		return ( new Status() )->is_staging_site();
6027
	}
6028
6029
	/**
6030
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6031
	 *
6032
	 * @since 4.4.0
6033
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6034
	 *
6035
	 * @return bool
6036
	 */
6037
	public static function validate_sync_error_idc_option() {
6038
		$is_valid = false;
6039
6040
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6041
		if ( false === $idc_allowed ) {
6042
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6043
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6044
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6045
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6046
				$transient_duration = HOUR_IN_SECONDS;
6047
			} else {
6048
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6049
				$idc_allowed        = '1';
6050
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6051
			}
6052
6053
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6054
		}
6055
6056
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6057
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6058
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6059
			$local_options = self::get_sync_error_idc_option();
6060
			// Ensure all values are set.
6061
			if ( isset( $sync_error['home'] ) && isset ( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6062
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6063
					$is_valid = true;
6064
				}
6065
			}
6066
6067
		}
6068
6069
		/**
6070
		 * Filters whether the sync_error_idc option is valid.
6071
		 *
6072
		 * @since 4.4.0
6073
		 *
6074
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6075
		 */
6076
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6077
6078
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6079
			// Since the option exists, and did not validate, delete it
6080
			Jetpack_Options::delete_option( 'sync_error_idc' );
6081
		}
6082
6083
		return $is_valid;
6084
	}
6085
6086
	/**
6087
	 * Normalizes a url by doing three things:
6088
	 *  - Strips protocol
6089
	 *  - Strips www
6090
	 *  - Adds a trailing slash
6091
	 *
6092
	 * @since 4.4.0
6093
	 * @param string $url
6094
	 * @return WP_Error|string
6095
	 */
6096
	public static function normalize_url_protocol_agnostic( $url ) {
6097
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6098
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6099
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
0 ignored issues
show
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...
6100
		}
6101
6102
		// Strip www and protocols
6103
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6104
		return $url;
6105
	}
6106
6107
	/**
6108
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6109
	 *
6110
	 * @since 4.4.0
6111
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6112
	 *
6113
	 * @param array $response
6114
	 * @return array Array of the local urls, wpcom urls, and error code
6115
	 */
6116
	public static function get_sync_error_idc_option( $response = array() ) {
6117
		// Since the local options will hit the database directly, store the values
6118
		// in a transient to allow for autoloading and caching on subsequent views.
6119
		$local_options = get_transient( 'jetpack_idc_local' );
6120
		if ( false === $local_options ) {
6121
			$local_options = array(
6122
				'home'    => Functions::home_url(),
6123
				'siteurl' => Functions::site_url(),
6124
			);
6125
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6126
		}
6127
6128
		$options = array_merge( $local_options, $response );
6129
6130
		$returned_values = array();
6131
		foreach ( $options as $key => $option ) {
6132
			if ( 'error_code' === $key ) {
6133
				$returned_values[ $key ] = $option;
6134
				continue;
6135
			}
6136
6137
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6138
				continue;
6139
			}
6140
6141
			$returned_values[ $key ] = $normalized_url;
6142
		}
6143
6144
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6145
6146
		return $returned_values;
6147
	}
6148
6149
	/**
6150
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6151
	 * If set to true, the site will be put into staging mode.
6152
	 *
6153
	 * @since 4.3.2
6154
	 * @return bool
6155
	 */
6156
	public static function sync_idc_optin() {
6157
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6158
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6159
		} else {
6160
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6161
		}
6162
6163
		/**
6164
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6165
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6166
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6167
		 *
6168
		 * @since 4.3.2
6169
		 *
6170
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6171
		 */
6172
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6173
	}
6174
6175
	/**
6176
	 * Maybe Use a .min.css stylesheet, maybe not.
6177
	 *
6178
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6179
	 */
6180
	public static function maybe_min_asset( $url, $path, $plugin ) {
6181
		// Short out on things trying to find actual paths.
6182
		if ( ! $path || empty( $plugin ) ) {
6183
			return $url;
6184
		}
6185
6186
		$path = ltrim( $path, '/' );
6187
6188
		// Strip out the abspath.
6189
		$base = dirname( plugin_basename( $plugin ) );
6190
6191
		// Short out on non-Jetpack assets.
6192
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6193
			return $url;
6194
		}
6195
6196
		// File name parsing.
6197
		$file              = "{$base}/{$path}";
6198
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6199
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6200
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6201
		$extension         = array_shift( $file_name_parts_r );
6202
6203
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6204
			// Already pointing at the minified version.
6205
			if ( 'min' === $file_name_parts_r[0] ) {
6206
				return $url;
6207
			}
6208
6209
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6210
			if ( file_exists( $min_full_path ) ) {
6211
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6212
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6213
				if ( 'css' === $extension ) {
6214
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6215
					self::$min_assets[ $key ] = $path;
6216
				}
6217
			}
6218
		}
6219
6220
		return $url;
6221
	}
6222
6223
	/**
6224
	 * If the asset is minified, let's flag .min as the suffix.
6225
	 *
6226
	 * Attached to `style_loader_src` filter.
6227
	 *
6228
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
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...
6229
	 * @param string $handle The registered handle of the script in question.
6230
	 * @param string $href The url of the asset in question.
0 ignored issues
show
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...
6231
	 */
6232
	public static function set_suffix_on_min( $src, $handle ) {
6233
		if ( false === strpos( $src, '.min.css' ) ) {
6234
			return $src;
6235
		}
6236
6237
		if ( ! empty( self::$min_assets ) ) {
6238
			foreach ( self::$min_assets as $file => $path ) {
6239
				if ( false !== strpos( $src, $file ) ) {
6240
					wp_style_add_data( $handle, 'suffix', '.min' );
6241
					return $src;
6242
				}
6243
			}
6244
		}
6245
6246
		return $src;
6247
	}
6248
6249
	/**
6250
	 * Maybe inlines a stylesheet.
6251
	 *
6252
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6253
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6254
	 *
6255
	 * Attached to `style_loader_tag` filter.
6256
	 *
6257
	 * @param string $tag The tag that would link to the external asset.
6258
	 * @param string $handle The registered handle of the script in question.
6259
	 *
6260
	 * @return string
6261
	 */
6262
	public static function maybe_inline_style( $tag, $handle ) {
6263
		global $wp_styles;
6264
		$item = $wp_styles->registered[ $handle ];
6265
6266
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6267
			return $tag;
6268
		}
6269
6270
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6271
			$href = $matches[1];
6272
			// Strip off query string
6273
			if ( $pos = strpos( $href, '?' ) ) {
6274
				$href = substr( $href, 0, $pos );
6275
			}
6276
			// Strip off fragment
6277
			if ( $pos = strpos( $href, '#' ) ) {
6278
				$href = substr( $href, 0, $pos );
6279
			}
6280
		} else {
6281
			return $tag;
6282
		}
6283
6284
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6285
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6286
			return $tag;
6287
		}
6288
6289
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6290
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6291
			// And this isn't the pass that actually deals with the RTL version...
6292
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6293
				// Short out, as the RTL version will deal with it in a moment.
6294
				return $tag;
6295
			}
6296
		}
6297
6298
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6299
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6300
		if ( $css ) {
6301
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6302
			if ( empty( $item->extra['after'] ) ) {
6303
				wp_add_inline_style( $handle, $css );
6304
			} else {
6305
				array_unshift( $item->extra['after'], $css );
6306
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6307
			}
6308
		}
6309
6310
		return $tag;
6311
	}
6312
6313
	/**
6314
	 * Loads a view file from the views
6315
	 *
6316
	 * Data passed in with the $data parameter will be available in the
6317
	 * template file as $data['value']
6318
	 *
6319
	 * @param string $template - Template file to load
6320
	 * @param array  $data - Any data to pass along to the template
6321
	 * @return boolean - If template file was found
6322
	 **/
6323
	public function load_view( $template, $data = array() ) {
6324
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6325
6326
		if ( file_exists( $views_dir . $template ) ) {
6327
			require_once $views_dir . $template;
6328
			return true;
6329
		}
6330
6331
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6332
		return false;
6333
	}
6334
6335
	/**
6336
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6337
	 */
6338
	public function deprecated_hooks() {
6339
		global $wp_filter;
6340
6341
		/*
6342
		 * Format:
6343
		 * deprecated_filter_name => replacement_name
6344
		 *
6345
		 * If there is no replacement, use null for replacement_name
6346
		 */
6347
		$deprecated_list = array(
6348
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6349
			'wpl_sharing_2014_1'                           => null,
6350
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6351
			'jetpack_identity_crisis_options_to_check'     => null,
6352
			'update_option_jetpack_single_user_site'       => null,
6353
			'audio_player_default_colors'                  => null,
6354
			'add_option_jetpack_featured_images_enabled'   => null,
6355
			'add_option_jetpack_update_details'            => null,
6356
			'add_option_jetpack_updates'                   => null,
6357
			'add_option_jetpack_network_name'              => null,
6358
			'add_option_jetpack_network_allow_new_registrations' => null,
6359
			'add_option_jetpack_network_add_new_users'     => null,
6360
			'add_option_jetpack_network_site_upload_space' => null,
6361
			'add_option_jetpack_network_upload_file_types' => null,
6362
			'add_option_jetpack_network_enable_administration_menus' => null,
6363
			'add_option_jetpack_is_multi_site'             => null,
6364
			'add_option_jetpack_is_main_network'           => null,
6365
			'add_option_jetpack_main_network_site'         => null,
6366
			'jetpack_sync_all_registered_options'          => null,
6367
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6368
			'jetpack_is_post_mailable'                     => null,
6369
			'jetpack_seo_site_host'                        => null,
6370
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6371
			'jetpack_holiday_snow_option_name'             => null,
6372
			'jetpack_holiday_chance_of_snow'               => null,
6373
			'jetpack_holiday_snow_js_url'                  => null,
6374
			'jetpack_is_holiday_snow_season'               => null,
6375
			'jetpack_holiday_snow_option_updated'          => null,
6376
			'jetpack_holiday_snowing'                      => null,
6377
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6378
			'jetpack_cache_plans'                          => null,
6379
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6380
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6381
			'jetpack_enable_site_verification'             => null,
6382
			'can_display_jetpack_manage_notice'            => null,
6383
			// Removed in Jetpack 7.3.0
6384
			'atd_load_scripts'                             => null,
6385
			'atd_http_post_timeout'                        => null,
6386
			'atd_http_post_error'                          => null,
6387
			'atd_service_domain'                           => null,
6388
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6389
			// Removed in Jetpack 7.9.0
6390
			'jetpack_pwa_manifest'                         => null,
6391
			'jetpack_pwa_background_color'                 => null,
6392
		);
6393
6394
		// This is a silly loop depth. Better way?
6395
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6396
			if ( has_action( $hook ) ) {
6397
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6398
					foreach ( $values as $hooked ) {
6399
						if ( is_callable( $hooked['function'] ) ) {
6400
							$function_name = 'an anonymous function';
6401
						} else {
6402
							$function_name = $hooked['function'];
6403
						}
6404
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6405
					}
6406
				}
6407
			}
6408
		}
6409
	}
6410
6411
	/**
6412
	 * Converts any url in a stylesheet, to the correct absolute url.
6413
	 *
6414
	 * Considerations:
6415
	 *  - Normal, relative URLs     `feh.png`
6416
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6417
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6418
	 *  - Absolute URLs             `http://domain.com/feh.png`
6419
	 *  - Domain root relative URLs `/feh.png`
6420
	 *
6421
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6422
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6423
	 *
6424
	 * @return mixed|string
6425
	 */
6426
	public static function absolutize_css_urls( $css, $css_file_url ) {
6427
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6428
		$css_dir = dirname( $css_file_url );
6429
		$p       = wp_parse_url( $css_dir );
6430
		$domain  = sprintf(
6431
			'%1$s//%2$s%3$s%4$s',
6432
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6433
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6434
			$p['host'],
6435
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6436
		);
6437
6438
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6439
			$find = $replace = array();
6440
			foreach ( $matches as $match ) {
6441
				$url = trim( $match['path'], "'\" \t" );
6442
6443
				// If this is a data url, we don't want to mess with it.
6444
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6445
					continue;
6446
				}
6447
6448
				// If this is an absolute or protocol-agnostic url,
6449
				// we don't want to mess with it.
6450
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6451
					continue;
6452
				}
6453
6454
				switch ( substr( $url, 0, 1 ) ) {
6455
					case '/':
6456
						$absolute = $domain . $url;
6457
						break;
6458
					default:
6459
						$absolute = $css_dir . '/' . $url;
6460
				}
6461
6462
				$find[]    = $match[0];
6463
				$replace[] = sprintf( 'url("%s")', $absolute );
6464
			}
6465
			$css = str_replace( $find, $replace, $css );
6466
		}
6467
6468
		return $css;
6469
	}
6470
6471
	/**
6472
	 * This methods removes all of the registered css files on the front end
6473
	 * from Jetpack in favor of using a single file. In effect "imploding"
6474
	 * all the files into one file.
6475
	 *
6476
	 * Pros:
6477
	 * - Uses only ONE css asset connection instead of 15
6478
	 * - Saves a minimum of 56k
6479
	 * - Reduces server load
6480
	 * - Reduces time to first painted byte
6481
	 *
6482
	 * Cons:
6483
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6484
	 *      should not cause any issues with themes.
6485
	 * - Plugins/themes dequeuing styles no longer do anything. See
6486
	 *      jetpack_implode_frontend_css filter for a workaround
6487
	 *
6488
	 * For some situations developers may wish to disable css imploding and
6489
	 * instead operate in legacy mode where each file loads seperately and
6490
	 * can be edited individually or dequeued. This can be accomplished with
6491
	 * the following line:
6492
	 *
6493
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6494
	 *
6495
	 * @since 3.2
6496
	 **/
6497
	public function implode_frontend_css( $travis_test = false ) {
6498
		$do_implode = true;
6499
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6500
			$do_implode = false;
6501
		}
6502
6503
		// Do not implode CSS when the page loads via the AMP plugin.
6504
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6505
			$do_implode = false;
6506
		}
6507
6508
		/**
6509
		 * Allow CSS to be concatenated into a single jetpack.css file.
6510
		 *
6511
		 * @since 3.2.0
6512
		 *
6513
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6514
		 */
6515
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6516
6517
		// Do not use the imploded file when default behavior was altered through the filter
6518
		if ( ! $do_implode ) {
6519
			return;
6520
		}
6521
6522
		// We do not want to use the imploded file in dev mode, or if not connected
6523
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6524
			if ( ! $travis_test ) {
6525
				return;
6526
			}
6527
		}
6528
6529
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6530
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6531
			return;
6532
		}
6533
6534
		/*
6535
		 * Now we assume Jetpack is connected and able to serve the single
6536
		 * file.
6537
		 *
6538
		 * In the future there will be a check here to serve the file locally
6539
		 * or potentially from the Jetpack CDN
6540
		 *
6541
		 * For now:
6542
		 * - Enqueue a single imploded css file
6543
		 * - Zero out the style_loader_tag for the bundled ones
6544
		 * - Be happy, drink scotch
6545
		 */
6546
6547
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6548
6549
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6550
6551
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6552
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6553
	}
6554
6555
	function concat_remove_style_loader_tag( $tag, $handle ) {
6556
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6557
			$tag = '';
6558
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6559
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6560
			}
6561
		}
6562
6563
		return $tag;
6564
	}
6565
6566
	/**
6567
	 * Add an async attribute to scripts that can be loaded asynchronously.
6568
	 * https://www.w3schools.com/tags/att_script_async.asp
6569
	 *
6570
	 * @since 7.7.0
6571
	 *
6572
	 * @param string $tag    The <script> tag for the enqueued script.
6573
	 * @param string $handle The script's registered handle.
6574
	 * @param string $src    The script's source URL.
6575
	 */
6576
	public function script_add_async( $tag, $handle, $src ) {
6577
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6578
			return preg_replace( '/^<script /i', '<script async ', $tag );
6579
		}
6580
6581
		return $tag;
6582
	}
6583
6584
	/*
6585
	 * Check the heartbeat data
6586
	 *
6587
	 * Organizes the heartbeat data by severity.  For example, if the site
6588
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6589
	 *
6590
	 * Data will be added to "caution" array, if it either:
6591
	 *  - Out of date Jetpack version
6592
	 *  - Out of date WP version
6593
	 *  - Out of date PHP version
6594
	 *
6595
	 * $return array $filtered_data
6596
	 */
6597
	public static function jetpack_check_heartbeat_data() {
6598
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6599
6600
		$good    = array();
6601
		$caution = array();
6602
		$bad     = array();
6603
6604
		foreach ( $raw_data as $stat => $value ) {
6605
6606
			// Check jetpack version
6607
			if ( 'version' == $stat ) {
6608
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6609
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6610
					continue;
6611
				}
6612
			}
6613
6614
			// Check WP version
6615
			if ( 'wp-version' == $stat ) {
6616
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6617
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6618
					continue;
6619
				}
6620
			}
6621
6622
			// Check PHP version
6623
			if ( 'php-version' == $stat ) {
6624
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6625
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_PHP_VERSION;
6626
					continue;
6627
				}
6628
			}
6629
6630
			// Check ID crisis
6631
			if ( 'identitycrisis' == $stat ) {
6632
				if ( 'yes' == $value ) {
6633
					$bad[ $stat ] = $value;
6634
					continue;
6635
				}
6636
			}
6637
6638
			// The rest are good :)
6639
			$good[ $stat ] = $value;
6640
		}
6641
6642
		$filtered_data = array(
6643
			'good'    => $good,
6644
			'caution' => $caution,
6645
			'bad'     => $bad,
6646
		);
6647
6648
		return $filtered_data;
6649
	}
6650
6651
6652
	/*
6653
	 * This method is used to organize all options that can be reset
6654
	 * without disconnecting Jetpack.
6655
	 *
6656
	 * It is used in class.jetpack-cli.php to reset options
6657
	 *
6658
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6659
	 *
6660
	 * @return array of options to delete.
6661
	 */
6662
	public static function get_jetpack_options_for_reset() {
6663
		return Jetpack_Options::get_options_for_reset();
6664
	}
6665
6666
	/*
6667
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6668
	 * so we can bring them directly to their site in calypso.
6669
	 *
6670
	 * @param string | url
6671
	 * @return string | url without the guff
6672
	 */
6673
	public static function build_raw_urls( $url ) {
6674
		$strip_http = '/.*?:\/\//i';
6675
		$url        = preg_replace( $strip_http, '', $url );
6676
		$url        = str_replace( '/', '::', $url );
6677
		return $url;
6678
	}
6679
6680
	/**
6681
	 * Stores and prints out domains to prefetch for page speed optimization.
6682
	 *
6683
	 * @param mixed $new_urls
6684
	 */
6685
	public static function dns_prefetch( $new_urls = null ) {
6686
		static $prefetch_urls = array();
6687
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6688
			echo "\r\n";
6689
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6690
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6691
			}
6692
		} elseif ( ! empty( $new_urls ) ) {
6693
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6694
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6695
			}
6696
			foreach ( (array) $new_urls as $this_new_url ) {
6697
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6698
			}
6699
			$prefetch_urls = array_unique( $prefetch_urls );
6700
		}
6701
	}
6702
6703
	public function wp_dashboard_setup() {
6704
		if ( self::is_active() ) {
6705
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6706
		}
6707
6708
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6709
			$jetpack_logo = new Jetpack_Logo();
6710
			$widget_title = sprintf(
6711
				wp_kses(
6712
					/* translators: Placeholder is a Jetpack logo. */
6713
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6714
					array( 'span' => array() )
6715
				),
6716
				$jetpack_logo->get_jp_emblem( true )
6717
			);
6718
6719
			wp_add_dashboard_widget(
6720
				'jetpack_summary_widget',
6721
				$widget_title,
6722
				array( __CLASS__, 'dashboard_widget' )
6723
			);
6724
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6725
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6726
6727
			// If we're inactive and not in development mode, sort our box to the top.
6728
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6729
				global $wp_meta_boxes;
6730
6731
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6732
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6733
6734
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6735
			}
6736
		}
6737
	}
6738
6739
	/**
6740
	 * @param mixed $result Value for the user's option
0 ignored issues
show
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...
6741
	 * @return mixed
6742
	 */
6743
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6744
		if ( ! is_array( $sorted ) ) {
6745
			return $sorted;
6746
		}
6747
6748
		foreach ( $sorted as $box_context => $ids ) {
6749
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6750
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6751
				continue;
6752
			}
6753
6754
			$ids_array = explode( ',', $ids );
6755
			$key       = array_search( 'dashboard_stats', $ids_array );
6756
6757
			if ( false !== $key ) {
6758
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6759
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6760
				$sorted[ $box_context ] = implode( ',', $ids_array );
6761
				// We've found it, stop searching, and just return.
6762
				break;
6763
			}
6764
		}
6765
6766
		return $sorted;
6767
	}
6768
6769
	public static function dashboard_widget() {
6770
		/**
6771
		 * Fires when the dashboard is loaded.
6772
		 *
6773
		 * @since 3.4.0
6774
		 */
6775
		do_action( 'jetpack_dashboard_widget' );
6776
	}
6777
6778
	public static function dashboard_widget_footer() {
6779
		?>
6780
		<footer>
6781
6782
		<div class="protect">
6783
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
6784
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6785
				<p class="blocked-count">
6786
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
6787
				</p>
6788
				<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>
6789
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
6790
				<a href="
6791
				<?php
6792
				echo esc_url(
6793
					wp_nonce_url(
6794
						self::admin_url(
6795
							array(
6796
								'action' => 'activate',
6797
								'module' => 'protect',
6798
							)
6799
						),
6800
						'jetpack_activate-protect'
6801
					)
6802
				);
6803
				?>
6804
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6805
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
6806
				</a>
6807
			<?php else : ?>
6808
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
6809
			<?php endif; ?>
6810
		</div>
6811
6812
		<div class="akismet">
6813
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
6814
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6815
				<p class="blocked-count">
6816
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
6817
				</p>
6818
				<p><?php echo esc_html_x( 'Blocked spam comments.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6819
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6820
				<a href="
6821
				<?php
6822
				echo esc_url(
6823
					wp_nonce_url(
6824
						add_query_arg(
6825
							array(
6826
								'action' => 'activate',
6827
								'plugin' => 'akismet/akismet.php',
6828
							),
6829
							admin_url( 'plugins.php' )
6830
						),
6831
						'activate-plugin_akismet/akismet.php'
6832
					)
6833
				);
6834
				?>
6835
							" class="button button-jetpack">
6836
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
6837
				</a>
6838
			<?php else : ?>
6839
				<p><a href="<?php echo esc_url( 'https://akismet.com/?utm_source=jetpack&utm_medium=link&utm_campaign=Jetpack%20Dashboard%20Widget%20Footer%20Link' ); ?>"><?php esc_html_e( 'Anti-spam can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
6840
			<?php endif; ?>
6841
		</div>
6842
6843
		</footer>
6844
		<?php
6845
	}
6846
6847
	/*
6848
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6849
	 */
6850
	function jetpack_icon_user_connected( $columns ) {
6851
		$columns['user_jetpack'] = '';
6852
		return $columns;
6853
	}
6854
6855
	/*
6856
	 * Show Jetpack icon if the user is linked.
6857
	 */
6858
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6859
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
6860
			$jetpack_logo = new Jetpack_Logo();
6861
			$emblem_html  = sprintf(
6862
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6863
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6864
				$jetpack_logo->get_jp_emblem()
6865
			);
6866
			return $emblem_html;
6867
		}
6868
6869
		return $val;
6870
	}
6871
6872
	/*
6873
	 * Style the Jetpack user column
6874
	 */
6875
	function jetpack_user_col_style() {
6876
		global $current_screen;
6877
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
6878
			?>
6879
			<style>
6880
				.fixed .column-user_jetpack {
6881
					width: 21px;
6882
				}
6883
				.jp-emblem-user-admin svg {
6884
					width: 20px;
6885
					height: 20px;
6886
				}
6887
				.jp-emblem-user-admin path {
6888
					fill: #00BE28;
6889
				}
6890
			</style>
6891
			<?php
6892
		}
6893
	}
6894
6895
	/**
6896
	 * Checks if Akismet is active and working.
6897
	 *
6898
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6899
	 * that implied usage of methods present since more recent version.
6900
	 * See https://github.com/Automattic/jetpack/pull/9585
6901
	 *
6902
	 * @since  5.1.0
6903
	 *
6904
	 * @return bool True = Akismet available. False = Aksimet not available.
6905
	 */
6906
	public static function is_akismet_active() {
6907
		static $status = null;
6908
6909
		if ( ! is_null( $status ) ) {
6910
			return $status;
6911
		}
6912
6913
		// Check if a modern version of Akismet is active.
6914
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6915
			$status = false;
6916
			return $status;
6917
		}
6918
6919
		// Make sure there is a key known to Akismet at all before verifying key.
6920
		$akismet_key = Akismet::get_api_key();
6921
		if ( ! $akismet_key ) {
6922
			$status = false;
6923
			return $status;
6924
		}
6925
6926
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6927
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6928
6929
		// 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.
6930
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6931
		// We cache the result of the Akismet key verification for ten minutes.
6932
		if ( ! $akismet_key_state || $recheck ) {
6933
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6934
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6935
		}
6936
6937
		$status = 'valid' === $akismet_key_state;
6938
6939
		return $status;
6940
	}
6941
6942
	/**
6943
	 * @deprecated
6944
	 *
6945
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
6946
	 */
6947
	public static function is_function_in_backtrace() {
6948
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
6949
	}
6950
6951
	/**
6952
	 * Given a minified path, and a non-minified path, will return
6953
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6954
	 *
6955
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6956
	 * root Jetpack directory.
6957
	 *
6958
	 * @since 5.6.0
6959
	 *
6960
	 * @param string $min_path
6961
	 * @param string $non_min_path
6962
	 * @return string The URL to the file
6963
	 */
6964
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6965
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
6966
	}
6967
6968
	/**
6969
	 * Checks for whether Jetpack Backup & Scan is enabled.
6970
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
6971
	 *
6972
	 * @return bool|int|mixed
6973
	 */
6974
	public static function is_rewind_enabled() {
6975
		if ( ! self::is_active() ) {
6976
			return false;
6977
		}
6978
6979
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6980
		if ( false === $rewind_enabled ) {
6981
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6982
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6983
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
6984
				&& ! empty( $rewind_data['state'] )
6985
				&& 'active' === $rewind_data['state'] )
6986
				? 1
6987
				: 0;
6988
6989
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
6990
		}
6991
		return $rewind_enabled;
6992
	}
6993
6994
	/**
6995
	 * Return Calypso environment value; used for developing Jetpack and pairing
6996
	 * it with different Calypso enrionments, such as localhost.
6997
	 *
6998
	 * @since 7.4.0
6999
	 *
7000
	 * @return string Calypso environment
7001
	 */
7002
	public static function get_calypso_env() {
7003
		if ( isset( $_GET['calypso_env'] ) ) {
7004
			return sanitize_key( $_GET['calypso_env'] );
7005
		}
7006
7007
		if ( getenv( 'CALYPSO_ENV' ) ) {
7008
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7009
		}
7010
7011
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7012
			return sanitize_key( CALYPSO_ENV );
7013
		}
7014
7015
		return '';
7016
	}
7017
7018
	/**
7019
	 * Checks whether or not TOS has been agreed upon.
7020
	 * Will return true if a user has clicked to register, or is already connected.
7021
	 */
7022
	public static function jetpack_tos_agreed() {
7023
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7024
7025
		$terms_of_service = new Terms_Of_Service();
7026
		return $terms_of_service->has_agreed();
7027
7028
	}
7029
7030
	/**
7031
	 * Handles activating default modules as well general cleanup for the new connection.
7032
	 *
7033
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7034
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7035
	 * @param boolean $send_state_messages          Whether to send state messages.
7036
	 * @return void
7037
	 */
7038
	public static function handle_post_authorization_actions(
7039
		$activate_sso = false,
7040
		$redirect_on_activation_error = false,
7041
		$send_state_messages = true
7042
	) {
7043
		$other_modules = $activate_sso
7044
			? array( 'sso' )
7045
			: array();
7046
7047
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7048
			self::delete_active_modules();
7049
7050
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
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...
7051
		} else {
7052
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7053
		}
7054
7055
		// Since this is a fresh connection, be sure to clear out IDC options
7056
		Jetpack_IDC::clear_all_idc_options();
7057
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7058
7059
		// Start nonce cleaner
7060
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7061
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7062
7063
		if ( $send_state_messages ) {
7064
			self::state( 'message', 'authorized' );
7065
		}
7066
	}
7067
7068
	/**
7069
	 * Returns a boolean for whether backups UI should be displayed or not.
7070
	 *
7071
	 * @return bool Should backups UI be displayed?
7072
	 */
7073
	public static function show_backups_ui() {
7074
		/**
7075
		 * Whether UI for backups should be displayed.
7076
		 *
7077
		 * @since 6.5.0
7078
		 *
7079
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7080
		 */
7081
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7082
	}
7083
7084
	/*
7085
	 * Deprecated manage functions
7086
	 */
7087
	function prepare_manage_jetpack_notice() {
7088
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7089
	}
7090
	function manage_activate_screen() {
7091
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7092
	}
7093
	function admin_jetpack_manage_notice() {
7094
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7095
	}
7096
	function opt_out_jetpack_manage_url() {
7097
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7098
	}
7099
	function opt_in_jetpack_manage_url() {
7100
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7101
	}
7102
	function opt_in_jetpack_manage_notice() {
7103
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7104
	}
7105
	function can_display_jetpack_manage_notice() {
7106
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7107
	}
7108
7109
	/**
7110
	 * Clean leftoveruser meta.
7111
	 *
7112
	 * Delete Jetpack-related user meta when it is no longer needed.
7113
	 *
7114
	 * @since 7.3.0
7115
	 *
7116
	 * @param int $user_id User ID being updated.
7117
	 */
7118
	public static function user_meta_cleanup( $user_id ) {
7119
		$meta_keys = array(
7120
			// AtD removed from Jetpack 7.3
7121
			'AtD_options',
7122
			'AtD_check_when',
7123
			'AtD_guess_lang',
7124
			'AtD_ignored_phrases',
7125
		);
7126
7127
		foreach ( $meta_keys as $meta_key ) {
7128
			if ( get_user_meta( $user_id, $meta_key ) ) {
7129
				delete_user_meta( $user_id, $meta_key );
7130
			}
7131
		}
7132
	}
7133
7134
	/**
7135
	 * Checks if a Jetpack site is both active and not in development.
7136
	 *
7137
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7138
	 *
7139
	 * @return bool True if Jetpack is active and not in development.
7140
	 */
7141
	public static function is_active_and_not_development_mode() {
7142
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7143
			return false;
7144
		}
7145
		return true;
7146
	}
7147
}
7148