Completed
Push — add/spellcheck-ci ( 63716c )
by
unknown
84:30 queued 78:20
created

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