Completed
Push — update/is-dev-mode-use-package... ( e8ee9b...0ef5d6 )
by
unknown
23:39 queued 17:12
created

class.jetpack.php (62 issues)

Upgrade to new PHP Analysis Engine

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

1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\Connection\Client;
5
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
6
use Automattic\Jetpack\Connection\REST_Connector as REST_Connector;
7
use Automattic\Jetpack\Connection\XMLRPC_Connector as XMLRPC_Connector;
8
use Automattic\Jetpack\Constants;
9
use Automattic\Jetpack\Roles;
10
use Automattic\Jetpack\Status;
11
use Automattic\Jetpack\Sync\Functions;
12
use Automattic\Jetpack\Sync\Sender;
13
use Automattic\Jetpack\Sync\Users;
14
use Automattic\Jetpack\Terms_Of_Service;
15
use Automattic\Jetpack\Tracking;
16
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
17
18
/*
19
Options:
20
jetpack_options (array)
21
	An array of options.
22
	@see Jetpack_Options::get_option_names()
23
24
jetpack_register (string)
25
	Temporary verification secrets.
26
27
jetpack_activated (int)
28
	1: the plugin was activated normally
29
	2: the plugin was activated on this site because of a network-wide activation
30
	3: the plugin was auto-installed
31
	4: the plugin was manually disconnected (but is still installed)
32
33
jetpack_active_modules (array)
34
	Array of active module slugs.
35
36
jetpack_do_activate (bool)
37
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
38
*/
39
40
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
41
42
class Jetpack {
43
	public $xmlrpc_server = null;
44
45
	private $rest_authentication_status = null;
46
47
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
48
49
	private $tracking;
50
51
	/**
52
	 * @var array The handles of styles that are concatenated into jetpack.css.
53
	 *
54
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
55
	 */
56
	public $concatenated_style_handles = array(
57
		'jetpack-carousel',
58
		'grunion.css',
59
		'the-neverending-homepage',
60
		'jetpack_likes',
61
		'jetpack_related-posts',
62
		'sharedaddy',
63
		'jetpack-slideshow',
64
		'presentations',
65
		'quiz',
66
		'jetpack-subscriptions',
67
		'jetpack-responsive-videos-style',
68
		'jetpack-social-menu',
69
		'tiled-gallery',
70
		'jetpack_display_posts_widget',
71
		'gravatar-profile-widget',
72
		'goodreads-widget',
73
		'jetpack_social_media_icons_widget',
74
		'jetpack-top-posts-widget',
75
		'jetpack_image_widget',
76
		'jetpack-my-community-widget',
77
		'jetpack-authors-widget',
78
		'wordads',
79
		'eu-cookie-law-style',
80
		'flickr-widget-style',
81
		'jetpack-search-widget',
82
		'jetpack-simple-payments-widget-style',
83
		'jetpack-widget-social-icons-styles',
84
	);
85
86
	/**
87
	 * The handles of scripts that can be loaded asynchronously.
88
	 *
89
	 * @var array
90
	 */
91
	public $async_script_handles = array(
92
		'woocommerce-analytics',
93
	);
94
95
	/**
96
	 * Contains all assets that have had their URL rewritten to minified versions.
97
	 *
98
	 * @var array
99
	 */
100
	static $min_assets = array();
101
102
	public $plugins_to_deactivate = array(
103
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
104
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
105
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
106
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
107
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
108
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
109
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
110
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
111
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
112
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
113
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
114
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
115
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
116
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
117
	);
118
119
	/**
120
	 * Map of roles we care about, and their corresponding minimum capabilities.
121
	 *
122
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
123
	 *
124
	 * @access public
125
	 * @static
126
	 *
127
	 * @var array
128
	 */
129
	public static $capability_translations = array(
130
		'administrator' => 'manage_options',
131
		'editor'        => 'edit_others_posts',
132
		'author'        => 'publish_posts',
133
		'contributor'   => 'edit_posts',
134
		'subscriber'    => 'read',
135
	);
136
137
	/**
138
	 * Map of modules that have conflicts with plugins and should not be auto-activated
139
	 * if the plugins are active.  Used by filter_default_modules
140
	 *
141
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
142
	 * change `module-slug` and add this to your plugin:
143
	 *
144
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
145
	 * function my_jetpack_get_default_modules( $modules ) {
146
	 *     return array_diff( $modules, array( 'module-slug' ) );
147
	 * }
148
	 *
149
	 * @var array
150
	 */
151
	private $conflicting_plugins = array(
152
		'comments'           => array(
153
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
154
			'Disqus'                         => 'disqus-comment-system/disqus.php',
155
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
156
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
157
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
158
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
159
		),
160
		'comment-likes'      => array(
161
			'Epoch' => 'epoch/plugincore.php',
162
		),
163
		'contact-form'       => array(
164
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
165
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
166
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
167
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
168
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
169
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
170
		),
171
		'minileven'          => array(
172
			'WPtouch' => 'wptouch/wptouch.php',
173
		),
174
		'latex'              => array(
175
			'LaTeX for WordPress'     => 'latex/latex.php',
176
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
177
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
178
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
179
			'Enable Latex'            => 'enable-latex/enable-latex.php',
180
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
181
		),
182
		'protect'            => array(
183
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
184
			'Captcha'                           => 'captcha/captcha.php',
185
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
186
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
187
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
188
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
189
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
190
			'Security-protection'               => 'security-protection/security-protection.php',
191
			'Login Security'                    => 'login-security/login-security.php',
192
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
193
			'Wordfence Security'                => 'wordfence/wordfence.php',
194
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
195
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
196
		),
197
		'random-redirect'    => array(
198
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
199
		),
200
		'related-posts'      => array(
201
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
202
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
203
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
204
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
205
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
206
			'outbrain'                    => 'outbrain/outbrain.php',
207
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
208
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
209
		),
210
		'sharedaddy'         => array(
211
			'AddThis'     => 'addthis/addthis_social_widget.php',
212
			'Add To Any'  => 'add-to-any/add-to-any.php',
213
			'ShareThis'   => 'share-this/sharethis.php',
214
			'Shareaholic' => 'shareaholic/shareaholic.php',
215
		),
216
		'seo-tools'          => array(
217
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
218
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
219
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
220
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
221
			'The SEO Framework'              => 'autodescription/autodescription.php',
222
		),
223
		'verification-tools' => array(
224
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
225
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
226
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
227
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
228
			'The SEO Framework'              => 'autodescription/autodescription.php',
229
		),
230
		'widget-visibility'  => array(
231
			'Widget Logic'    => 'widget-logic/widget_logic.php',
232
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
233
		),
234
		'sitemaps'           => array(
235
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
236
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
237
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
238
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
239
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
240
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
241
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
242
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
243
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
244
			'The SEO Framework'                    => 'autodescription/autodescription.php',
245
			'Sitemap'                              => 'sitemap/sitemap.php',
246
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
247
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
248
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
249
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
250
		),
251
		'lazy-images'        => array(
252
			'Lazy Load'              => 'lazy-load/lazy-load.php',
253
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
254
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
255
		),
256
	);
257
258
	/**
259
	 * Plugins for which we turn off our Facebook OG Tags implementation.
260
	 *
261
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
262
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
263
	 *
264
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
265
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
266
	 */
267
	private $open_graph_conflicting_plugins = array(
268
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
269
		// 2 Click Social Media Buttons
270
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
271
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
272
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
273
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
274
		// Open Graph Meta Tags by Heateor
275
		'facebook/facebook.php',                                 // Facebook (official plugin)
276
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
277
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
278
		// Facebook Featured Image & OG Meta Tags
279
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
280
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
281
		// Facebook Open Graph Meta Tags for WordPress
282
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
283
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
284
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
285
		// Fedmich's Facebook Open Graph Meta
286
		'network-publisher/networkpub.php',                      // Network Publisher
287
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
288
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
289
		// NextScripts SNAP
290
		'og-tags/og-tags.php',                                   // OG Tags
291
		'opengraph/opengraph.php',                               // Open Graph
292
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
293
		// Open Graph Protocol Framework
294
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
295
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
296
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
297
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
298
		'sharepress/sharepress.php',                             // SharePress
299
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
300
		'social-discussions/social-discussions.php',             // Social Discussions
301
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
302
		'socialize/socialize.php',                               // Socialize
303
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
304
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
305
		// Tweet, Like, Google +1 and Share
306
		'wordbooker/wordbooker.php',                             // Wordbooker
307
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
308
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
309
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
310
		// WP Facebook Like Send & Open Graph Meta
311
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
312
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
313
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
314
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
315
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
316
	);
317
318
	/**
319
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
320
	 */
321
	private $twitter_cards_conflicting_plugins = array(
322
		// 'twitter/twitter.php',                       // The official one handles this on its own.
323
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
324
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
325
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
326
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
327
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
328
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
329
		'twitter-cards/twitter-cards.php',           // Twitter Cards
330
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
331
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
332
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
333
	);
334
335
	/**
336
	 * Message to display in admin_notice
337
	 *
338
	 * @var string
339
	 */
340
	public $message = '';
341
342
	/**
343
	 * Error to display in admin_notice
344
	 *
345
	 * @var string
346
	 */
347
	public $error = '';
348
349
	/**
350
	 * Modules that need more privacy description.
351
	 *
352
	 * @var string
353
	 */
354
	public $privacy_checks = '';
355
356
	/**
357
	 * Stats to record once the page loads
358
	 *
359
	 * @var array
360
	 */
361
	public $stats = array();
362
363
	/**
364
	 * Jetpack_Sync object
365
	 */
366
	public $sync;
367
368
	/**
369
	 * Verified data for JSON authorization request
370
	 */
371
	public $json_api_authorization_request = array();
372
373
	/**
374
	 * @var Automattic\Jetpack\Connection\Manager
375
	 */
376
	protected $connection_manager;
377
378
	/**
379
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
380
	 */
381
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
382
383
	/**
384
	 * Holds the singleton instance of this class
385
	 *
386
	 * @since 2.3.3
387
	 * @var Jetpack
388
	 */
389
	static $instance = false;
390
391
	/**
392
	 * Singleton
393
	 *
394
	 * @static
395
	 */
396
	public static function init() {
397
		if ( ! self::$instance ) {
398
			self::$instance = new Jetpack();
399
400
			self::$instance->plugin_upgrade();
401
		}
402
403
		return self::$instance;
404
	}
405
406
	/**
407
	 * Must never be called statically
408
	 */
409
	function plugin_upgrade() {
410
		if ( self::is_active() ) {
411
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
412
			if ( JETPACK__VERSION != $version ) {
413
				// Prevent multiple upgrades at once - only a single process should trigger
414
				// an upgrade to avoid stampedes
415
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
416
					return;
417
				}
418
419
				// Set a short lock to prevent multiple instances of the upgrade
420
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
421
422
				// check which active modules actually exist and remove others from active_modules list
423
				$unfiltered_modules = self::get_active_modules();
424
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
425
				if ( array_diff( $unfiltered_modules, $modules ) ) {
426
					self::update_active_modules( $modules );
427
				}
428
429
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
430
431
				// Upgrade to 4.3.0
432
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
433
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
434
				}
435
436
				// Make sure Markdown for posts gets turned back on
437
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
438
					update_option( 'wpcom_publish_posts_with_markdown', true );
439
				}
440
441
				if ( did_action( 'wp_loaded' ) ) {
442
					self::upgrade_on_load();
443
				} else {
444
					add_action(
445
						'wp_loaded',
446
						array( __CLASS__, 'upgrade_on_load' )
447
					);
448
				}
449
			}
450
		}
451
	}
452
453
	/**
454
	 * Runs upgrade routines that need to have modules loaded.
455
	 */
456
	static function upgrade_on_load() {
457
458
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
459
		// This can happen in case Jetpack has been just upgraded and is
460
		// being initialized late during the page load. In this case we wait
461
		// until the next proper admin page load with Jetpack active.
462
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
463
			delete_transient( self::$plugin_upgrade_lock_key );
464
465
			return;
466
		}
467
468
		self::maybe_set_version_option();
469
470
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
471
			Jetpack_Widget_Conditions::migrate_post_type_rules();
472
		}
473
474
		if (
475
			class_exists( 'Jetpack_Sitemap_Manager' )
476
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
477
		) {
478
			do_action( 'jetpack_sitemaps_purge_data' );
479
		}
480
481
		// Delete old stats cache
482
		delete_option( 'jetpack_restapi_stats_cache' );
483
484
		delete_transient( self::$plugin_upgrade_lock_key );
485
	}
486
487
	/**
488
	 * Saves all the currently active modules to options.
489
	 * Also fires Action hooks for each newly activated and deactivated module.
490
	 *
491
	 * @param $modules Array Array of active modules to be saved in options.
492
	 *
493
	 * @return $success bool true for success, false for failure.
0 ignored issues
show
The doc-type $success could not be parsed: Unknown type name "$success" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
494
	 */
495
	static function update_active_modules( $modules ) {
496
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
497
		$active_modules       = self::get_active_modules();
498
		$new_active_modules   = array_diff( $modules, $current_modules );
499
		$new_inactive_modules = array_diff( $active_modules, $modules );
500
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
501
		$reindexed_modules    = array_values( $new_current_modules );
502
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
503
504
		foreach ( $new_active_modules as $module ) {
505
			/**
506
			 * Fires when a specific module is activated.
507
			 *
508
			 * @since 1.9.0
509
			 *
510
			 * @param string $module Module slug.
511
			 * @param boolean $success whether the module was activated. @since 4.2
512
			 */
513
			do_action( 'jetpack_activate_module', $module, $success );
514
			/**
515
			 * Fires when a module is activated.
516
			 * The dynamic part of the filter, $module, is the module slug.
517
			 *
518
			 * @since 1.9.0
519
			 *
520
			 * @param string $module Module slug.
521
			 */
522
			do_action( "jetpack_activate_module_$module", $module );
523
		}
524
525
		foreach ( $new_inactive_modules as $module ) {
526
			/**
527
			 * Fired after a module has been deactivated.
528
			 *
529
			 * @since 4.2.0
530
			 *
531
			 * @param string $module Module slug.
532
			 * @param boolean $success whether the module was deactivated.
533
			 */
534
			do_action( 'jetpack_deactivate_module', $module, $success );
535
			/**
536
			 * Fires when a module is deactivated.
537
			 * The dynamic part of the filter, $module, is the module slug.
538
			 *
539
			 * @since 1.9.0
540
			 *
541
			 * @param string $module Module slug.
542
			 */
543
			do_action( "jetpack_deactivate_module_$module", $module );
544
		}
545
546
		return $success;
547
	}
548
549
	static function delete_active_modules() {
550
		self::update_active_modules( array() );
551
	}
552
553
	/**
554
	 * Constructor.  Initializes WordPress hooks
555
	 */
556
	private function __construct() {
557
		/*
558
		 * Check for and alert any deprecated hooks
559
		 */
560
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
561
562
		/*
563
		 * Enable enhanced handling of previewing sites in Calypso
564
		 */
565
		if ( self::is_active() ) {
566
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
567
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
568
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
569
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
570
		}
571
572
		add_action( 'plugins_loaded', array( $this, 'after_plugins_loaded' )  );
573
574
		add_filter(
575
			'jetpack_connection_secret_generator',
576
			function( $callable ) {
577
				return function() {
578
					return wp_generate_password( 32, false );
579
				};
580
			}
581
		);
582
583
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
584
585
		$this->connection_manager = new Connection_Manager();
586
		$this->connection_manager->init();
587
588
		/*
589
		 * Load things that should only be in Network Admin.
590
		 *
591
		 * For now blow away everything else until a more full
592
		 * understanding of what is needed at the network level is
593
		 * available
594
		 */
595
		if ( is_multisite() ) {
596
			$network = Jetpack_Network::init();
597
			$network->set_connection( $this->connection_manager );
598
		}
599
600
		add_filter(
601
			'jetpack_signature_check_token',
602
			array( __CLASS__, 'verify_onboarding_token' ),
603
			10,
604
			3
605
		);
606
607
		/**
608
		 * Prepare Gutenberg Editor functionality
609
		 */
610
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
611
		Jetpack_Gutenberg::init();
612
		Jetpack_Gutenberg::load_independent_blocks();
613
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
614
615
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
616
617
		// Unlink user before deleting the user from WP.com.
618
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
619
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
620
621
		// Initialize remote file upload request handlers.
622
		$this->add_remote_request_handlers();
623
624
		if ( self::is_active() ) {
625
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
626
627
			Jetpack_Heartbeat::init();
628
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
629
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
630
				Jetpack_Search_Performance_Logger::init();
631
			}
632
		}
633
634
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
635
636
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
637
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
638
639
		add_action( 'admin_init', array( $this, 'admin_init' ) );
640
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
641
642
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
643
644
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
645
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
646
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
647
648
		// returns HTTPS support status
649
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
650
651
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
652
653
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
654
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
655
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
656
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
657
658
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
659
660
		/**
661
		 * These actions run checks to load additional files.
662
		 * They check for external files or plugins, so they need to run as late as possible.
663
		 */
664
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
665
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
666
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
667
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
668
669
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
670
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
671
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
672
673
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
674
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
675
676
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
677
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
678
679
		// A filter to control all just in time messages
680
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
681
682
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
683
684
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
685
		// We should make sure to only do this for front end links.
686
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
687
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
688
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
689
690
			// we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
691
			// so they point moderation links on emails to Calypso
692
			jetpack_require_lib( 'functions.wp-notify' );
693
		}
694
695
		// Hide edit post link if mobile app.
696
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
697
			add_filter( 'edit_post_link', '__return_empty_string' );
698
		}
699
700
		// Update the Jetpack plan from API on heartbeats
701
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
702
703
		/**
704
		 * This is the hack to concatenate all css files into one.
705
		 * For description and reasoning see the implode_frontend_css method
706
		 *
707
		 * Super late priority so we catch all the registered styles
708
		 */
709
		if ( ! is_admin() ) {
710
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
711
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
712
		}
713
714
		/**
715
		 * These are sync actions that we need to keep track of for jitms
716
		 */
717
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
718
719
		// Actually push the stats on shutdown.
720
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
721
			add_action( 'shutdown', array( $this, 'push_stats' ) );
722
		}
723
724
		/*
725
		 * Load some scripts asynchronously.
726
		 */
727
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
728
	}
729
	/**
730
	 * Runs after all the plugins have loaded but before init.
731
	 */
732
	function after_plugins_loaded() {
733
734
		$terms_of_service = new Terms_Of_Service();
735
		$tracking = new Plugin_Tracking();
736
		if ( $terms_of_service->has_agreed() ) {
737
			add_action( 'init', array( $tracking, 'init' ) );
738
		} else {
739
			/**
740
			 * Initialize tracking right after the user agrees to the terms of service.
741
			 */
742
			add_action( 'jetpack_agreed_to_terms_of_service', array( $tracking, 'init' ) );
743
		}
744
	}
745
746
	/**
747
	 * Sets up the XMLRPC request handlers.
748
	 *
749
	 * @deprecated since 7.7.0
750
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
751
	 *
752
	 * @param Array                 $request_params Incoming request parameters.
753
	 * @param Boolean               $is_active      Whether the connection is currently active.
754
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
755
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
Should the type for parameter $xmlrpc_server not be null|Jetpack_XMLRPC_Server?

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

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

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

Loading history...
756
	 */
757
	public function setup_xmlrpc_handlers(
758
		$request_params,
759
		$is_active,
760
		$is_signed,
761
		Jetpack_XMLRPC_Server $xmlrpc_server = null
762
	) {
763
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
764
		return $this->connection_manager->setup_xmlrpc_handlers(
765
			$request_params,
766
			$is_active,
767
			$is_signed,
768
			$xmlrpc_server
769
		);
770
	}
771
772
	/**
773
	 * Initialize REST API registration connector.
774
	 *
775
	 * @deprecated since 7.7.0
776
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
777
	 */
778
	public function initialize_rest_api_registration_connector() {
779
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
780
		$this->connection_manager->initialize_rest_api_registration_connector();
781
	}
782
783
	/**
784
	 * This is ported over from the manage module, which has been deprecated and baked in here.
785
	 *
786
	 * @param $domains
787
	 */
788
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
789
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
790
	}
791
792
	/**
793
	 * Return $domains, with 'wordpress.com' appended.
794
	 * This is ported over from the manage module, which has been deprecated and baked in here.
795
	 *
796
	 * @param $domains
797
	 * @return array
798
	 */
799
	function allow_wpcom_domain( $domains ) {
800
		if ( empty( $domains ) ) {
801
			$domains = array();
802
		}
803
		$domains[] = 'wordpress.com';
804
		return array_unique( $domains );
805
	}
806
807
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
808
		$post = get_post( $post_id );
809
810
		if ( empty( $post ) ) {
811
			return $default_url;
812
		}
813
814
		$post_type = $post->post_type;
815
816
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
817
		// https://en.support.wordpress.com/custom-post-types/
818
		$allowed_post_types = array(
819
			'post'                => 'post',
820
			'page'                => 'page',
821
			'jetpack-portfolio'   => 'edit/jetpack-portfolio',
822
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
823
		);
824
825
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
826
			return $default_url;
827
		}
828
829
		$path_prefix = $allowed_post_types[ $post_type ];
830
831
		$site_slug = self::build_raw_urls( get_home_url() );
832
833
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
834
	}
835
836
	function point_edit_comment_links_to_calypso( $url ) {
837
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
838
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
The variable $query_args does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
839
		return esc_url(
840
			sprintf(
841
				'https://wordpress.com/comment/%s/%d',
842
				self::build_raw_urls( get_home_url() ),
843
				$query_args['amp;c']
844
			)
845
		);
846
	}
847
848
	function jetpack_track_last_sync_callback( $params ) {
849
		/**
850
		 * Filter to turn off jitm caching
851
		 *
852
		 * @since 5.4.0
853
		 *
854
		 * @param bool false Whether to cache just in time messages
855
		 */
856
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
857
			return $params;
858
		}
859
860
		if ( is_array( $params ) && isset( $params[0] ) ) {
861
			$option = $params[0];
862
			if ( 'active_plugins' === $option ) {
863
				// use the cache if we can, but not terribly important if it gets evicted
864
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
865
			}
866
		}
867
868
		return $params;
869
	}
870
871
	function jetpack_connection_banner_callback() {
872
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
873
874
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
875
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
876
			wp_send_json_success();
877
		}
878
879
		wp_die();
880
	}
881
882
	/**
883
	 * Removes all XML-RPC methods that are not `jetpack.*`.
884
	 * Only used in our alternate XML-RPC endpoint, where we want to
885
	 * ensure that Core and other plugins' methods are not exposed.
886
	 *
887
	 * @deprecated since 7.7.0
888
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
889
	 *
890
	 * @param array $methods A list of registered WordPress XMLRPC methods.
891
	 * @return array Filtered $methods
892
	 */
893
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
894
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
895
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
896
	}
897
898
	/**
899
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
900
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
901
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
902
	 * which is accessible via a different URI. Most of the below is copied directly
903
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
904
	 *
905
	 * @deprecated since 7.7.0
906
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
907
	 */
908
	public function alternate_xmlrpc() {
909
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
910
		$this->connection_manager->alternate_xmlrpc();
911
	}
912
913
	/**
914
	 * The callback for the JITM ajax requests.
915
	 *
916
	 * @deprecated since 7.9.0
917
	 */
918
	function jetpack_jitm_ajax_callback() {
919
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
920
	}
921
922
	/**
923
	 * If there are any stats that need to be pushed, but haven't been, push them now.
924
	 */
925
	function push_stats() {
926
		if ( ! empty( $this->stats ) ) {
927
			$this->do_stats( 'server_side' );
928
		}
929
	}
930
931
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
932
		$status = new Status();
933
		switch ( $cap ) {
934
			case 'jetpack_connect':
935
			case 'jetpack_reconnect':
936
				if ( $status->is_development_mode() ) {
937
					$caps = array( 'do_not_allow' );
938
					break;
939
				}
940
				/**
941
				 * Pass through. If it's not development mode, these should match disconnect.
942
				 * Let users disconnect if it's development mode, just in case things glitch.
943
				 */
944
			case 'jetpack_disconnect':
945
				/**
946
				 * In multisite, can individual site admins manage their own connection?
947
				 *
948
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
949
				 */
950
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
951
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
952
						/**
953
						 * We need to update the option name -- it's terribly unclear which
954
						 * direction the override goes.
955
						 *
956
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
957
						 */
958
						$caps = array( 'do_not_allow' );
959
						break;
960
					}
961
				}
962
963
				$caps = array( 'manage_options' );
964
				break;
965
			case 'jetpack_manage_modules':
966
			case 'jetpack_activate_modules':
967
			case 'jetpack_deactivate_modules':
968
				$caps = array( 'manage_options' );
969
				break;
970
			case 'jetpack_configure_modules':
971
				$caps = array( 'manage_options' );
972
				break;
973
			case 'jetpack_manage_autoupdates':
974
				$caps = array(
975
					'manage_options',
976
					'update_plugins',
977
				);
978
				break;
979
			case 'jetpack_network_admin_page':
980
			case 'jetpack_network_settings_page':
981
				$caps = array( 'manage_network_plugins' );
982
				break;
983
			case 'jetpack_network_sites_page':
984
				$caps = array( 'manage_sites' );
985
				break;
986
			case 'jetpack_admin_page':
987
				if ( $status->is_development_mode() ) {
988
					$caps = array( 'manage_options' );
989
					break;
990
				} else {
991
					$caps = array( 'read' );
992
				}
993
				break;
994
			case 'jetpack_connect_user':
995
				if ( $status->is_development_mode() ) {
996
					$caps = array( 'do_not_allow' );
997
					break;
998
				}
999
				$caps = array( 'read' );
1000
				break;
1001
		}
1002
		return $caps;
1003
	}
1004
1005
	/**
1006
	 * Require a Jetpack authentication.
1007
	 *
1008
	 * @deprecated since 7.7.0
1009
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1010
	 */
1011
	public function require_jetpack_authentication() {
1012
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1013
		$this->connection_manager->require_jetpack_authentication();
1014
	}
1015
1016
	/**
1017
	 * Load language files
1018
	 *
1019
	 * @action plugins_loaded
1020
	 */
1021
	public static function plugin_textdomain() {
1022
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1023
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1024
	}
1025
1026
	/**
1027
	 * Register assets for use in various modules and the Jetpack admin page.
1028
	 *
1029
	 * @uses wp_script_is, wp_register_script, plugins_url
1030
	 * @action wp_loaded
1031
	 * @return null
1032
	 */
1033
	public function register_assets() {
1034
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1035
			wp_register_script(
1036
				'spin',
1037
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1038
				false,
1039
				'1.3'
1040
			);
1041
		}
1042
1043 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1044
			wp_register_script(
1045
				'jquery.spin',
1046
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1047
				array( 'jquery', 'spin' ),
1048
				'1.3'
1049
			);
1050
		}
1051
1052 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1053
			wp_register_script(
1054
				'jetpack-gallery-settings',
1055
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1056
				array( 'media-views' ),
1057
				'20121225'
1058
			);
1059
		}
1060
1061 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1062
			wp_register_script(
1063
				'jetpack-twitter-timeline',
1064
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1065
				array( 'jquery' ),
1066
				'4.0.0',
1067
				true
1068
			);
1069
		}
1070
1071
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1072
			wp_register_script(
1073
				'jetpack-facebook-embed',
1074
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1075
				array( 'jquery' ),
1076
				null,
1077
				true
1078
			);
1079
1080
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1081
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1082
			if ( ! is_numeric( $fb_app_id ) ) {
1083
				$fb_app_id = '';
1084
			}
1085
			wp_localize_script(
1086
				'jetpack-facebook-embed',
1087
				'jpfbembed',
1088
				array(
1089
					'appid'  => $fb_app_id,
1090
					'locale' => $this->get_locale(),
1091
				)
1092
			);
1093
		}
1094
1095
		/**
1096
		 * As jetpack_register_genericons is by default fired off a hook,
1097
		 * the hook may have already fired by this point.
1098
		 * So, let's just trigger it manually.
1099
		 */
1100
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1101
		jetpack_register_genericons();
1102
1103
		/**
1104
		 * Register the social logos
1105
		 */
1106
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1107
		jetpack_register_social_logos();
1108
1109 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1110
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1111
		}
1112
	}
1113
1114
	/**
1115
	 * Guess locale from language code.
1116
	 *
1117
	 * @param string $lang Language code.
1118
	 * @return string|bool
1119
	 */
1120 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1121
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1122
			return 'en_US';
1123
		}
1124
1125
		if ( ! class_exists( 'GP_Locales' ) ) {
1126
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1127
				return false;
1128
			}
1129
1130
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1131
		}
1132
1133
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1134
			// WP.com: get_locale() returns 'it'
1135
			$locale = GP_Locales::by_slug( $lang );
1136
		} else {
1137
			// Jetpack: get_locale() returns 'it_IT';
1138
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1139
		}
1140
1141
		if ( ! $locale ) {
1142
			return false;
1143
		}
1144
1145
		if ( empty( $locale->facebook_locale ) ) {
1146
			if ( empty( $locale->wp_locale ) ) {
1147
				return false;
1148
			} else {
1149
				// Facebook SDK is smart enough to fall back to en_US if a
1150
				// locale isn't supported. Since supported Facebook locales
1151
				// can fall out of sync, we'll attempt to use the known
1152
				// wp_locale value and rely on said fallback.
1153
				return $locale->wp_locale;
1154
			}
1155
		}
1156
1157
		return $locale->facebook_locale;
1158
	}
1159
1160
	/**
1161
	 * Get the locale.
1162
	 *
1163
	 * @return string|bool
1164
	 */
1165
	function get_locale() {
1166
		$locale = $this->guess_locale_from_lang( get_locale() );
1167
1168
		if ( ! $locale ) {
1169
			$locale = 'en_US';
1170
		}
1171
1172
		return $locale;
1173
	}
1174
1175
	/**
1176
	 * Device Pixels support
1177
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1178
	 */
1179
	function devicepx() {
1180
		if ( self::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1181
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1182
		}
1183
	}
1184
1185
	/**
1186
	 * Return the network_site_url so that .com knows what network this site is a part of.
1187
	 *
1188
	 * @param  bool $option
1189
	 * @return string
1190
	 */
1191
	public function jetpack_main_network_site_option( $option ) {
1192
		return network_site_url();
1193
	}
1194
	/**
1195
	 * Network Name.
1196
	 */
1197
	static function network_name( $option = null ) {
1198
		global $current_site;
1199
		return $current_site->site_name;
1200
	}
1201
	/**
1202
	 * Does the network allow new user and site registrations.
1203
	 *
1204
	 * @return string
1205
	 */
1206
	static function network_allow_new_registrations( $option = null ) {
1207
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1208
	}
1209
	/**
1210
	 * Does the network allow admins to add new users.
1211
	 *
1212
	 * @return boolian
1213
	 */
1214
	static function network_add_new_users( $option = null ) {
1215
		return (bool) get_site_option( 'add_new_users' );
1216
	}
1217
	/**
1218
	 * File upload psace left per site in MB.
1219
	 *  -1 means NO LIMIT.
1220
	 *
1221
	 * @return number
1222
	 */
1223
	static function network_site_upload_space( $option = null ) {
1224
		// value in MB
1225
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1226
	}
1227
1228
	/**
1229
	 * Network allowed file types.
1230
	 *
1231
	 * @return string
1232
	 */
1233
	static function network_upload_file_types( $option = null ) {
1234
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1235
	}
1236
1237
	/**
1238
	 * Maximum file upload size set by the network.
1239
	 *
1240
	 * @return number
1241
	 */
1242
	static function network_max_upload_file_size( $option = null ) {
1243
		// value in KB
1244
		return get_site_option( 'fileupload_maxk', 300 );
1245
	}
1246
1247
	/**
1248
	 * Lets us know if a site allows admins to manage the network.
1249
	 *
1250
	 * @return array
1251
	 */
1252
	static function network_enable_administration_menus( $option = null ) {
1253
		return get_site_option( 'menu_items' );
1254
	}
1255
1256
	/**
1257
	 * If a user has been promoted to or demoted from admin, we need to clear the
1258
	 * jetpack_other_linked_admins transient.
1259
	 *
1260
	 * @since 4.3.2
1261
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1262
	 *
1263
	 * @param int    $user_id   The user ID whose role changed.
1264
	 * @param string $role      The new role.
1265
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Should the type for parameter $old_roles not be array|null?

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

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

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

Loading history...
1266
	 */
1267
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1268
		if ( 'administrator' == $role
1269
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1270
			|| is_null( $old_roles )
1271
		) {
1272
			delete_transient( 'jetpack_other_linked_admins' );
1273
		}
1274
	}
1275
1276
	/**
1277
	 * Checks to see if there are any other users available to become primary
1278
	 * Users must both:
1279
	 * - Be linked to wpcom
1280
	 * - Be an admin
1281
	 *
1282
	 * @return mixed False if no other users are linked, Int if there are.
1283
	 */
1284
	static function get_other_linked_admins() {
1285
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1286
1287
		if ( false === $other_linked_users ) {
1288
			$admins = get_users( array( 'role' => 'administrator' ) );
1289
			if ( count( $admins ) > 1 ) {
1290
				$available = array();
1291
				foreach ( $admins as $admin ) {
1292
					if ( self::is_user_connected( $admin->ID ) ) {
1293
						$available[] = $admin->ID;
1294
					}
1295
				}
1296
1297
				$count_connected_admins = count( $available );
1298
				if ( count( $available ) > 1 ) {
1299
					$other_linked_users = $count_connected_admins;
1300
				} else {
1301
					$other_linked_users = 0;
1302
				}
1303
			} else {
1304
				$other_linked_users = 0;
1305
			}
1306
1307
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1308
		}
1309
1310
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1311
	}
1312
1313
	/**
1314
	 * Return whether we are dealing with a multi network setup or not.
1315
	 * The reason we are type casting this is because we want to avoid the situation where
1316
	 * the result is false since when is_main_network_option return false it cases
1317
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1318
	 * database which could be set to anything as opposed to what this function returns.
1319
	 *
1320
	 * @param  bool $option
1321
	 *
1322
	 * @return boolean
1323
	 */
1324
	public function is_main_network_option( $option ) {
1325
		// return '1' or ''
1326
		return (string) (bool) self::is_multi_network();
1327
	}
1328
1329
	/**
1330
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1331
	 *
1332
	 * @param  string $option
1333
	 * @return boolean
1334
	 */
1335
	public function is_multisite( $option ) {
1336
		return (string) (bool) is_multisite();
1337
	}
1338
1339
	/**
1340
	 * Implemented since there is no core is multi network function
1341
	 * Right now there is no way to tell if we which network is the dominant network on the system
1342
	 *
1343
	 * @since  3.3
1344
	 * @return boolean
1345
	 */
1346 View Code Duplication
	public static function is_multi_network() {
1347
		global  $wpdb;
1348
1349
		// if we don't have a multi site setup no need to do any more
1350
		if ( ! is_multisite() ) {
1351
			return false;
1352
		}
1353
1354
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1355
		if ( $num_sites > 1 ) {
1356
			return true;
1357
		} else {
1358
			return false;
1359
		}
1360
	}
1361
1362
	/**
1363
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1364
	 *
1365
	 * @return null
1366
	 */
1367
	function update_jetpack_main_network_site_option() {
1368
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1369
	}
1370
	/**
1371
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1372
	 */
1373
	function update_jetpack_network_settings() {
1374
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1375
		// Only sync this info for the main network site.
1376
	}
1377
1378
	/**
1379
	 * Get back if the current site is single user site.
1380
	 *
1381
	 * @return bool
1382
	 */
1383 View Code Duplication
	public static function is_single_user_site() {
1384
		global $wpdb;
1385
1386
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1387
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1388
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1389
		}
1390
		return 1 === (int) $some_users;
1391
	}
1392
1393
	/**
1394
	 * Returns true if the site has file write access false otherwise.
1395
	 *
1396
	 * @return string ( '1' | '0' )
1397
	 **/
1398
	public static function file_system_write_access() {
1399
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1400
			require_once ABSPATH . 'wp-admin/includes/file.php';
1401
		}
1402
1403
		require_once ABSPATH . 'wp-admin/includes/template.php';
1404
1405
		$filesystem_method = get_filesystem_method();
1406
		if ( $filesystem_method === 'direct' ) {
1407
			return 1;
1408
		}
1409
1410
		ob_start();
1411
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1412
		ob_end_clean();
1413
		if ( $filesystem_credentials_are_stored ) {
1414
			return 1;
1415
		}
1416
		return 0;
1417
	}
1418
1419
	/**
1420
	 * Finds out if a site is using a version control system.
1421
	 *
1422
	 * @return string ( '1' | '0' )
1423
	 **/
1424
	public static function is_version_controlled() {
1425
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1426
		return (string) (int) Functions::is_version_controlled();
1427
	}
1428
1429
	/**
1430
	 * Determines whether the current theme supports featured images or not.
1431
	 *
1432
	 * @return string ( '1' | '0' )
1433
	 */
1434
	public static function featured_images_enabled() {
1435
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1436
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1437
	}
1438
1439
	/**
1440
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1441
	 *
1442
	 * @deprecated 4.7 use get_avatar_url instead.
1443
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1444
	 * @param int               $size Size of the avatar image
1445
	 * @param string            $default URL to a default image to use if no avatar is available
1446
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1447
	 *
1448
	 * @return array
1449
	 */
1450
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1451
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1452
		return get_avatar_url(
1453
			$id_or_email,
1454
			array(
1455
				'size'          => $size,
1456
				'default'       => $default,
1457
				'force_default' => $force_display,
1458
			)
1459
		);
1460
	}
1461
1462
	/**
1463
	 * jetpack_updates is saved in the following schema:
1464
	 *
1465
	 * array (
1466
	 *      'plugins'                       => (int) Number of plugin updates available.
1467
	 *      'themes'                        => (int) Number of theme updates available.
1468
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1469
	 *      'translations'                  => (int) Number of translation updates available.
1470
	 *      'total'                         => (int) Total of all available updates.
1471
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1472
	 * )
1473
	 *
1474
	 * @return array
1475
	 */
1476
	public static function get_updates() {
1477
		$update_data = wp_get_update_data();
1478
1479
		// Stores the individual update counts as well as the total count.
1480
		if ( isset( $update_data['counts'] ) ) {
1481
			$updates = $update_data['counts'];
1482
		}
1483
1484
		// If we need to update WordPress core, let's find the latest version number.
1485 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1486
			$cur = get_preferred_from_update_core();
1487
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1488
				$updates['wp_update_version'] = $cur->current;
1489
			}
1490
		}
1491
		return isset( $updates ) ? $updates : array();
1492
	}
1493
1494
	public static function get_update_details() {
1495
		$update_details = array(
1496
			'update_core'    => get_site_transient( 'update_core' ),
1497
			'update_plugins' => get_site_transient( 'update_plugins' ),
1498
			'update_themes'  => get_site_transient( 'update_themes' ),
1499
		);
1500
		return $update_details;
1501
	}
1502
1503
	public static function refresh_update_data() {
1504
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1505
1506
	}
1507
1508
	public static function refresh_theme_data() {
1509
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1510
	}
1511
1512
	/**
1513
	 * Is Jetpack active?
1514
	 */
1515
	public static function is_active() {
1516
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
1517
	}
1518
1519
	/**
1520
	 * Make an API call to WordPress.com for plan status
1521
	 *
1522
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1523
	 *
1524
	 * @return bool True if plan is updated, false if no update
1525
	 */
1526
	public static function refresh_active_plan_from_wpcom() {
1527
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1528
		return Jetpack_Plan::refresh_from_wpcom();
1529
	}
1530
1531
	/**
1532
	 * Get the plan that this Jetpack site is currently using
1533
	 *
1534
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1535
	 * @return array Active Jetpack plan details.
1536
	 */
1537
	public static function get_active_plan() {
1538
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1539
		return Jetpack_Plan::get();
1540
	}
1541
1542
	/**
1543
	 * Determine whether the active plan supports a particular feature
1544
	 *
1545
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1546
	 * @return bool True if plan supports feature, false if not.
1547
	 */
1548
	public static function active_plan_supports( $feature ) {
1549
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1550
		return Jetpack_Plan::supports( $feature );
1551
	}
1552
1553
	/**
1554
	 * Is Jetpack in development (offline) mode?
1555
	 *
1556
	 * @deprecated since 8.0
1557
	 */
1558
	public static function is_development_mode() {
1559
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Status->is_development_mode' );
1560
		$status = new Status();
1561
		return $status->is_development_mode();
1562
	}
1563
1564
	/**
1565
	 * Whether the site is currently onboarding or not.
1566
	 * A site is considered as being onboarded if it currently has an onboarding token.
1567
	 *
1568
	 * @since 5.8
1569
	 *
1570
	 * @access public
1571
	 * @static
1572
	 *
1573
	 * @return bool True if the site is currently onboarding, false otherwise
1574
	 */
1575
	public static function is_onboarding() {
1576
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1577
	}
1578
1579
	/**
1580
	 * Determines reason for Jetpack development mode.
1581
	 */
1582
	public static function development_mode_trigger_text() {
1583
		$status = new Status();
1584
		if ( ! $status->is_development_mode() ) {
1585
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1586
		}
1587
1588
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1589
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1590
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1591
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1592
		} else {
1593
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1594
		}
1595
1596
		return $notice;
1597
1598
	}
1599
	/**
1600
	 * Get Jetpack development mode notice text and notice class.
1601
	 *
1602
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1603
	 */
1604
	public static function show_development_mode_notice() {
1605
		$status = new Status();
1606 View Code Duplication
		if ( $status->is_development_mode() ) {
1607
			$notice = sprintf(
1608
				/* translators: %s is a URL */
1609
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1610
				'https://jetpack.com/support/development-mode/'
1611
			);
1612
1613
			$notice .= ' ' . self::development_mode_trigger_text();
1614
1615
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1616
		}
1617
1618
		// Throw up a notice if using a development version and as for feedback.
1619
		if ( self::is_development_version() ) {
1620
			/* translators: %s is a URL */
1621
			$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/' );
1622
1623
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1624
		}
1625
		// Throw up a notice if using staging mode
1626
		if ( self::is_staging_site() ) {
1627
			/* translators: %s is a URL */
1628
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1629
1630
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1631
		}
1632
	}
1633
1634
	/**
1635
	 * Whether Jetpack's version maps to a public release, or a development version.
1636
	 */
1637
	public static function is_development_version() {
1638
		/**
1639
		 * Allows filtering whether this is a development version of Jetpack.
1640
		 *
1641
		 * This filter is especially useful for tests.
1642
		 *
1643
		 * @since 4.3.0
1644
		 *
1645
		 * @param bool $development_version Is this a develoment version of Jetpack?
1646
		 */
1647
		return (bool) apply_filters(
1648
			'jetpack_development_version',
1649
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1650
		);
1651
	}
1652
1653
	/**
1654
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1655
	 */
1656
	public static function is_user_connected( $user_id = false ) {
1657
		return self::connection()->is_user_connected( $user_id );
1658
	}
1659
1660
	/**
1661
	 * Get the wpcom user data of the current|specified connected user.
1662
	 */
1663 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1664
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1665
		if ( ! $user_id ) {
1666
			$user_id = get_current_user_id();
1667
		}
1668
1669
		$transient_key = "jetpack_connected_user_data_$user_id";
1670
1671
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1672
			return $cached_user_data;
1673
		}
1674
1675
		$xml = new Jetpack_IXR_Client(
1676
			array(
1677
				'user_id' => $user_id,
1678
			)
1679
		);
1680
		$xml->query( 'wpcom.getUser' );
1681
		if ( ! $xml->isError() ) {
1682
			$user_data = $xml->getResponse();
1683
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1684
			return $user_data;
1685
		}
1686
1687
		return false;
1688
	}
1689
1690
	/**
1691
	 * Get the wpcom email of the current|specified connected user.
1692
	 */
1693 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1694
		if ( ! $user_id ) {
1695
			$user_id = get_current_user_id();
1696
		}
1697
1698
		$xml = new Jetpack_IXR_Client(
1699
			array(
1700
				'user_id' => $user_id,
1701
			)
1702
		);
1703
		$xml->query( 'wpcom.getUserEmail' );
1704
		if ( ! $xml->isError() ) {
1705
			return $xml->getResponse();
1706
		}
1707
		return false;
1708
	}
1709
1710
	/**
1711
	 * Get the wpcom email of the master user.
1712
	 */
1713
	public static function get_master_user_email() {
1714
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1715
		if ( $master_user_id ) {
1716
			return self::get_connected_user_email( $master_user_id );
1717
		}
1718
		return '';
1719
	}
1720
1721
	/**
1722
	 * Whether the current user is the connection owner.
1723
	 *
1724
	 * @deprecated since 7.7
1725
	 *
1726
	 * @return bool Whether the current user is the connection owner.
1727
	 */
1728
	public function current_user_is_connection_owner() {
1729
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1730
		return self::connection()->is_connection_owner();
1731
	}
1732
1733
	/**
1734
	 * Gets current user IP address.
1735
	 *
1736
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1737
	 *
1738
	 * @return string                  Current user IP address.
1739
	 */
1740
	public static function current_user_ip( $check_all_headers = false ) {
1741
		if ( $check_all_headers ) {
1742
			foreach ( array(
1743
				'HTTP_CF_CONNECTING_IP',
1744
				'HTTP_CLIENT_IP',
1745
				'HTTP_X_FORWARDED_FOR',
1746
				'HTTP_X_FORWARDED',
1747
				'HTTP_X_CLUSTER_CLIENT_IP',
1748
				'HTTP_FORWARDED_FOR',
1749
				'HTTP_FORWARDED',
1750
				'HTTP_VIA',
1751
			) as $key ) {
1752
				if ( ! empty( $_SERVER[ $key ] ) ) {
1753
					return $_SERVER[ $key ];
1754
				}
1755
			}
1756
		}
1757
1758
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1759
	}
1760
1761
	/**
1762
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1763
	 */
1764
	function extra_oembed_providers() {
1765
		// Cloudup: https://dev.cloudup.com/#oembed
1766
		wp_oembed_add_provider( 'https://cloudup.com/*', 'https://cloudup.com/oembed' );
1767
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1768
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1769
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1770
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1771
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1772
		wp_oembed_add_provider( 'https://song.link/*', 'https://song.link/oembed', false );
1773
	}
1774
1775
	/**
1776
	 * Synchronize connected user role changes
1777
	 */
1778
	function user_role_change( $user_id ) {
1779
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1780
		Users::user_role_change( $user_id );
1781
	}
1782
1783
	/**
1784
	 * Loads the currently active modules.
1785
	 */
1786
	public static function load_modules() {
1787
		$status = new Status();
1788
		$is_development_mode = $status->is_development_mode();
1789
		if (
1790
			! self::is_active()
1791
			&& ! $is_development_mode
1792
			&& ! self::is_onboarding()
1793
			&& (
1794
				! is_multisite()
1795
				|| ! get_site_option( 'jetpack_protect_active' )
1796
			)
1797
		) {
1798
			return;
1799
		}
1800
1801
		$version = Jetpack_Options::get_option( 'version' );
1802 View Code Duplication
		if ( ! $version ) {
1803
			$version = $old_version = JETPACK__VERSION . ':' . time();
1804
			/** This action is documented in class.jetpack.php */
1805
			do_action( 'updating_jetpack_version', $version, false );
1806
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1807
		}
1808
		list( $version ) = explode( ':', $version );
1809
1810
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1811
1812
		$modules_data = array();
1813
1814
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1815
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1816
			$updated_modules = array();
1817
			foreach ( $modules as $module ) {
1818
				$modules_data[ $module ] = self::get_module( $module );
1819
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1820
					continue;
1821
				}
1822
1823
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1824
					continue;
1825
				}
1826
1827
				$updated_modules[] = $module;
1828
			}
1829
1830
			$modules = array_diff( $modules, $updated_modules );
1831
		}
1832
1833
		foreach ( $modules as $index => $module ) {
1834
			// If we're in dev mode, disable modules requiring a connection
1835
			if ( $is_development_mode ) {
1836
				// Prime the pump if we need to
1837
				if ( empty( $modules_data[ $module ] ) ) {
1838
					$modules_data[ $module ] = self::get_module( $module );
1839
				}
1840
				// If the module requires a connection, but we're in local mode, don't include it.
1841
				if ( $modules_data[ $module ]['requires_connection'] ) {
1842
					continue;
1843
				}
1844
			}
1845
1846
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1847
				continue;
1848
			}
1849
1850
			if ( ! include_once self::get_module_path( $module ) ) {
1851
				unset( $modules[ $index ] );
1852
				self::update_active_modules( array_values( $modules ) );
1853
				continue;
1854
			}
1855
1856
			/**
1857
			 * Fires when a specific module is loaded.
1858
			 * The dynamic part of the hook, $module, is the module slug.
1859
			 *
1860
			 * @since 1.1.0
1861
			 */
1862
			do_action( 'jetpack_module_loaded_' . $module );
1863
		}
1864
1865
		/**
1866
		 * Fires when all the modules are loaded.
1867
		 *
1868
		 * @since 1.1.0
1869
		 */
1870
		do_action( 'jetpack_modules_loaded' );
1871
1872
		// Load module-specific code that is needed even when a module isn't active. Loaded here because code contained therein may need actions such as setup_theme.
1873
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1874
	}
1875
1876
	/**
1877
	 * Check if Jetpack's REST API compat file should be included
1878
	 *
1879
	 * @action plugins_loaded
1880
	 * @return null
1881
	 */
1882
	public function check_rest_api_compat() {
1883
		/**
1884
		 * Filters the list of REST API compat files to be included.
1885
		 *
1886
		 * @since 2.2.5
1887
		 *
1888
		 * @param array $args Array of REST API compat files to include.
1889
		 */
1890
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1891
1892
		if ( function_exists( 'bbpress' ) ) {
1893
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1894
		}
1895
1896
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1897
			require_once $_jetpack_rest_api_compat_include;
1898
		}
1899
	}
1900
1901
	/**
1902
	 * Gets all plugins currently active in values, regardless of whether they're
1903
	 * traditionally activated or network activated.
1904
	 *
1905
	 * @todo Store the result in core's object cache maybe?
1906
	 */
1907
	public static function get_active_plugins() {
1908
		$active_plugins = (array) get_option( 'active_plugins', array() );
1909
1910
		if ( is_multisite() ) {
1911
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1912
			// whereas active_plugins stores them in the values.
1913
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1914
			if ( $network_plugins ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $network_plugins of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1915
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1916
			}
1917
		}
1918
1919
		sort( $active_plugins );
1920
1921
		return array_unique( $active_plugins );
1922
	}
1923
1924
	/**
1925
	 * Gets and parses additional plugin data to send with the heartbeat data
1926
	 *
1927
	 * @since 3.8.1
1928
	 *
1929
	 * @return array Array of plugin data
1930
	 */
1931
	public static function get_parsed_plugin_data() {
1932
		if ( ! function_exists( 'get_plugins' ) ) {
1933
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
1934
		}
1935
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1936
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1937
		$active_plugins = self::get_active_plugins();
1938
1939
		$plugins = array();
1940
		foreach ( $all_plugins as $path => $plugin_data ) {
1941
			$plugins[ $path ] = array(
1942
				'is_active' => in_array( $path, $active_plugins ),
1943
				'file'      => $path,
1944
				'name'      => $plugin_data['Name'],
1945
				'version'   => $plugin_data['Version'],
1946
				'author'    => $plugin_data['Author'],
1947
			);
1948
		}
1949
1950
		return $plugins;
1951
	}
1952
1953
	/**
1954
	 * Gets and parses theme data to send with the heartbeat data
1955
	 *
1956
	 * @since 3.8.1
1957
	 *
1958
	 * @return array Array of theme data
1959
	 */
1960
	public static function get_parsed_theme_data() {
1961
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
1962
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1963
1964
		$themes = array();
1965
		foreach ( $all_themes as $slug => $theme_data ) {
1966
			$theme_headers = array();
1967
			foreach ( $header_keys as $header_key ) {
1968
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1969
			}
1970
1971
			$themes[ $slug ] = array(
1972
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
1973
				'slug'            => $slug,
1974
				'theme_root'      => $theme_data->get_theme_root_uri(),
1975
				'parent'          => $theme_data->parent(),
1976
				'headers'         => $theme_headers,
1977
			);
1978
		}
1979
1980
		return $themes;
1981
	}
1982
1983
	/**
1984
	 * Checks whether a specific plugin is active.
1985
	 *
1986
	 * We don't want to store these in a static variable, in case
1987
	 * there are switch_to_blog() calls involved.
1988
	 */
1989
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1990
		return in_array( $plugin, self::get_active_plugins() );
1991
	}
1992
1993
	/**
1994
	 * Check if Jetpack's Open Graph tags should be used.
1995
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1996
	 *
1997
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1998
	 * @action plugins_loaded
1999
	 * @return null
2000
	 */
2001
	public function check_open_graph() {
2002
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2003
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2004
		}
2005
2006
		$active_plugins = self::get_active_plugins();
2007
2008
		if ( ! empty( $active_plugins ) ) {
2009
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2010
				if ( in_array( $plugin, $active_plugins ) ) {
2011
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2012
					break;
2013
				}
2014
			}
2015
		}
2016
2017
		/**
2018
		 * Allow the addition of Open Graph Meta Tags to all pages.
2019
		 *
2020
		 * @since 2.0.3
2021
		 *
2022
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2023
		 */
2024
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2025
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2026
		}
2027
	}
2028
2029
	/**
2030
	 * Check if Jetpack's Twitter tags should be used.
2031
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2032
	 *
2033
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2034
	 * @action plugins_loaded
2035
	 * @return null
2036
	 */
2037
	public function check_twitter_tags() {
2038
2039
		$active_plugins = self::get_active_plugins();
2040
2041
		if ( ! empty( $active_plugins ) ) {
2042
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2043
				if ( in_array( $plugin, $active_plugins ) ) {
2044
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2045
					break;
2046
				}
2047
			}
2048
		}
2049
2050
		/**
2051
		 * Allow Twitter Card Meta tags to be disabled.
2052
		 *
2053
		 * @since 2.6.0
2054
		 *
2055
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2056
		 */
2057
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2058
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2059
		}
2060
	}
2061
2062
	/**
2063
	 * Allows plugins to submit security reports.
2064
	 *
2065
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2066
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2067
	 * @param array  $args         See definitions above
2068
	 */
2069
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2070
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2071
	}
2072
2073
	/* Jetpack Options API */
2074
2075
	public static function get_option_names( $type = 'compact' ) {
2076
		return Jetpack_Options::get_option_names( $type );
2077
	}
2078
2079
	/**
2080
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2081
	 *
2082
	 * @param string $name    Option name
2083
	 * @param mixed  $default (optional)
2084
	 */
2085
	public static function get_option( $name, $default = false ) {
2086
		return Jetpack_Options::get_option( $name, $default );
2087
	}
2088
2089
	/**
2090
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2091
	 *
2092
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2093
	 * @param string $name  Option name
2094
	 * @param mixed  $value Option value
2095
	 */
2096
	public static function update_option( $name, $value ) {
2097
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2098
		return Jetpack_Options::update_option( $name, $value );
2099
	}
2100
2101
	/**
2102
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2103
	 *
2104
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2105
	 * @param array $array array( option name => option value, ... )
2106
	 */
2107
	public static function update_options( $array ) {
2108
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2109
		return Jetpack_Options::update_options( $array );
2110
	}
2111
2112
	/**
2113
	 * Deletes the given option.  May be passed multiple option names as an array.
2114
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2115
	 *
2116
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2117
	 * @param string|array $names
2118
	 */
2119
	public static function delete_option( $names ) {
2120
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2121
		return Jetpack_Options::delete_option( $names );
2122
	}
2123
2124
	/**
2125
	 * Enters a user token into the user_tokens option
2126
	 *
2127
	 * @param int    $user_id
2128
	 * @param string $token
2129
	 * return bool
2130
	 */
2131
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2132
		// not designed for concurrent updates
2133
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2134
		if ( ! is_array( $user_tokens ) ) {
2135
			$user_tokens = array();
2136
		}
2137
		$user_tokens[ $user_id ] = $token;
2138
		if ( $is_master_user ) {
2139
			$master_user = $user_id;
2140
			$options     = compact( 'user_tokens', 'master_user' );
2141
		} else {
2142
			$options = compact( 'user_tokens' );
2143
		}
2144
		return Jetpack_Options::update_options( $options );
2145
	}
2146
2147
	/**
2148
	 * Returns an array of all PHP files in the specified absolute path.
2149
	 * Equivalent to glob( "$absolute_path/*.php" ).
2150
	 *
2151
	 * @param string $absolute_path The absolute path of the directory to search.
2152
	 * @return array Array of absolute paths to the PHP files.
2153
	 */
2154
	public static function glob_php( $absolute_path ) {
2155
		if ( function_exists( 'glob' ) ) {
2156
			return glob( "$absolute_path/*.php" );
2157
		}
2158
2159
		$absolute_path = untrailingslashit( $absolute_path );
2160
		$files         = array();
2161
		if ( ! $dir = @opendir( $absolute_path ) ) {
2162
			return $files;
2163
		}
2164
2165
		while ( false !== $file = readdir( $dir ) ) {
2166
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2167
				continue;
2168
			}
2169
2170
			$file = "$absolute_path/$file";
2171
2172
			if ( ! is_file( $file ) ) {
2173
				continue;
2174
			}
2175
2176
			$files[] = $file;
2177
		}
2178
2179
		closedir( $dir );
2180
2181
		return $files;
2182
	}
2183
2184
	public static function activate_new_modules( $redirect = false ) {
2185
		$status = new Status();
2186
		if ( ! self::is_active() && ! $status->is_development_mode() ) {
2187
			return;
2188
		}
2189
2190
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2191 View Code Duplication
		if ( ! $jetpack_old_version ) {
2192
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2193
			/** This action is documented in class.jetpack.php */
2194
			do_action( 'updating_jetpack_version', $version, false );
2195
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2196
		}
2197
2198
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2199
2200
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2201
			return;
2202
		}
2203
2204
		$active_modules     = self::get_active_modules();
2205
		$reactivate_modules = array();
2206
		foreach ( $active_modules as $active_module ) {
2207
			$module = self::get_module( $active_module );
2208
			if ( ! isset( $module['changed'] ) ) {
2209
				continue;
2210
			}
2211
2212
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2213
				continue;
2214
			}
2215
2216
			$reactivate_modules[] = $active_module;
2217
			self::deactivate_module( $active_module );
2218
		}
2219
2220
		$new_version = JETPACK__VERSION . ':' . time();
2221
		/** This action is documented in class.jetpack.php */
2222
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2223
		Jetpack_Options::update_options(
2224
			array(
2225
				'version'     => $new_version,
2226
				'old_version' => $jetpack_old_version,
2227
			)
2228
		);
2229
2230
		self::state( 'message', 'modules_activated' );
2231
		self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
0 ignored issues
show
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2232
2233
		if ( $redirect ) {
2234
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2235
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2236
				$page = $_GET['page'];
2237
			}
2238
2239
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2240
			exit;
2241
		}
2242
	}
2243
2244
	/**
2245
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2246
	 * Make sure to tuck away module "library" files in a sub-directory.
2247
	 */
2248
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2249
		static $modules = null;
2250
2251
		if ( ! isset( $modules ) ) {
2252
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2253
			// Use the cache if we're on the front-end and it's available...
2254
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2255
				$modules = $available_modules_option[ JETPACK__VERSION ];
2256
			} else {
2257
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2258
2259
				$modules = array();
2260
2261
				foreach ( $files as $file ) {
2262
					if ( ! $headers = self::get_module( $file ) ) {
2263
						continue;
2264
					}
2265
2266
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2267
				}
2268
2269
				Jetpack_Options::update_option(
2270
					'available_modules',
2271
					array(
2272
						JETPACK__VERSION => $modules,
2273
					)
2274
				);
2275
			}
2276
		}
2277
2278
		/**
2279
		 * Filters the array of modules available to be activated.
2280
		 *
2281
		 * @since 2.4.0
2282
		 *
2283
		 * @param array $modules Array of available modules.
2284
		 * @param string $min_version Minimum version number required to use modules.
2285
		 * @param string $max_version Maximum version number required to use modules.
2286
		 */
2287
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2288
2289
		if ( ! $min_version && ! $max_version ) {
2290
			return array_keys( $mods );
2291
		}
2292
2293
		$r = array();
2294
		foreach ( $mods as $slug => $introduced ) {
2295
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2296
				continue;
2297
			}
2298
2299
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2300
				continue;
2301
			}
2302
2303
			$r[] = $slug;
2304
		}
2305
2306
		return $r;
2307
	}
2308
2309
	/**
2310
	 * Default modules loaded on activation.
2311
	 */
2312
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2313
		$return = array();
2314
2315
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2316
			$module_data = self::get_module( $module );
2317
2318
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2319
				case 'yes':
2320
					$return[] = $module;
2321
					break;
2322
				case 'public':
2323
					if ( Jetpack_Options::get_option( 'public' ) ) {
2324
						$return[] = $module;
2325
					}
2326
					break;
2327
				case 'no':
2328
				default:
2329
					break;
2330
			}
2331
		}
2332
		/**
2333
		 * Filters the array of default modules.
2334
		 *
2335
		 * @since 2.5.0
2336
		 *
2337
		 * @param array $return Array of default modules.
2338
		 * @param string $min_version Minimum version number required to use modules.
2339
		 * @param string $max_version Maximum version number required to use modules.
2340
		 */
2341
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2342
	}
2343
2344
	/**
2345
	 * Checks activated modules during auto-activation to determine
2346
	 * if any of those modules are being deprecated.  If so, close
2347
	 * them out, and add any replacement modules.
2348
	 *
2349
	 * Runs at priority 99 by default.
2350
	 *
2351
	 * This is run late, so that it can still activate a module if
2352
	 * the new module is a replacement for another that the user
2353
	 * currently has active, even if something at the normal priority
2354
	 * would kibosh everything.
2355
	 *
2356
	 * @since 2.6
2357
	 * @uses jetpack_get_default_modules filter
2358
	 * @param array $modules
2359
	 * @return array
2360
	 */
2361
	function handle_deprecated_modules( $modules ) {
2362
		$deprecated_modules = array(
2363
			'debug'            => null,  // Closed out and moved to the debugger library.
2364
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2365
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2366
		);
2367
2368
		// Don't activate SSO if they never completed activating WPCC.
2369
		if ( self::is_module_active( 'wpcc' ) ) {
2370
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2371
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2372
				$deprecated_modules['wpcc'] = null;
2373
			}
2374
		}
2375
2376
		foreach ( $deprecated_modules as $module => $replacement ) {
2377
			if ( self::is_module_active( $module ) ) {
2378
				self::deactivate_module( $module );
2379
				if ( $replacement ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $replacement of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

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