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