Completed
Push — add/late-initialization ( f33f94 )
by
unknown
06:33
created

Jetpack::late_initalization()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 11

Duplication

Lines 0
Ratio 0 %

Importance

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

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

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

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

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

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

Loading history...
787
	 */
788
	public function setup_xmlrpc_handlers(
789
		$request_params,
790
		$is_active,
791
		$is_signed,
792
		Jetpack_XMLRPC_Server $xmlrpc_server = null
793
	) {
794
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
795
		return $this->connection_manager->setup_xmlrpc_handlers(
796
			$request_params,
797
			$is_active,
798
			$is_signed,
799
			$xmlrpc_server
800
		);
801
	}
802
803
	/**
804
	 * Initialize REST API registration connector.
805
	 *
806
	 * @deprecated since 7.7.0
807
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
808
	 */
809
	public function initialize_rest_api_registration_connector() {
810
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
811
		$this->connection_manager->initialize_rest_api_registration_connector();
812
	}
813
814
	/**
815
	 * This is ported over from the manage module, which has been deprecated and baked in here.
816
	 *
817
	 * @param $domains
818
	 */
819
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
820
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
821
	}
822
823
	/**
824
	 * Return $domains, with 'wordpress.com' appended.
825
	 * This is ported over from the manage module, which has been deprecated and baked in here.
826
	 *
827
	 * @param $domains
828
	 * @return array
829
	 */
830
	function allow_wpcom_domain( $domains ) {
831
		if ( empty( $domains ) ) {
832
			$domains = array();
833
		}
834
		$domains[] = 'wordpress.com';
835
		return array_unique( $domains );
836
	}
837
838
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
839
		$post = get_post( $post_id );
840
841
		if ( empty( $post ) ) {
842
			return $default_url;
843
		}
844
845
		$post_type = $post->post_type;
846
847
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
848
		// https://en.support.wordpress.com/custom-post-types/
849
		$allowed_post_types = array(
850
			'post'                => 'post',
851
			'page'                => 'page',
852
			'jetpack-portfolio'   => 'edit/jetpack-portfolio',
853
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
854
		);
855
856
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
857
			return $default_url;
858
		}
859
860
		$path_prefix = $allowed_post_types[ $post_type ];
861
862
		$site_slug = self::build_raw_urls( get_home_url() );
863
864
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
865
	}
866
867
	function point_edit_comment_links_to_calypso( $url ) {
868
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
869
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

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

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

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

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

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

Loading history...
1297
	 */
1298
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1299
		if ( 'administrator' == $role
1300
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1301
			|| is_null( $old_roles )
1302
		) {
1303
			delete_transient( 'jetpack_other_linked_admins' );
1304
		}
1305
	}
1306
1307
	/**
1308
	 * Checks to see if there are any other users available to become primary
1309
	 * Users must both:
1310
	 * - Be linked to wpcom
1311
	 * - Be an admin
1312
	 *
1313
	 * @return mixed False if no other users are linked, Int if there are.
1314
	 */
1315
	static function get_other_linked_admins() {
1316
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1317
1318
		if ( false === $other_linked_users ) {
1319
			$admins = get_users( array( 'role' => 'administrator' ) );
1320
			if ( count( $admins ) > 1 ) {
1321
				$available = array();
1322
				foreach ( $admins as $admin ) {
1323
					if ( self::is_user_connected( $admin->ID ) ) {
1324
						$available[] = $admin->ID;
1325
					}
1326
				}
1327
1328
				$count_connected_admins = count( $available );
1329
				if ( count( $available ) > 1 ) {
1330
					$other_linked_users = $count_connected_admins;
1331
				} else {
1332
					$other_linked_users = 0;
1333
				}
1334
			} else {
1335
				$other_linked_users = 0;
1336
			}
1337
1338
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1339
		}
1340
1341
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1342
	}
1343
1344
	/**
1345
	 * Return whether we are dealing with a multi network setup or not.
1346
	 * The reason we are type casting this is because we want to avoid the situation where
1347
	 * the result is false since when is_main_network_option return false it cases
1348
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1349
	 * database which could be set to anything as opposed to what this function returns.
1350
	 *
1351
	 * @param  bool $option
1352
	 *
1353
	 * @return boolean
1354
	 */
1355
	public function is_main_network_option( $option ) {
1356
		// return '1' or ''
1357
		return (string) (bool) self::is_multi_network();
1358
	}
1359
1360
	/**
1361
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1362
	 *
1363
	 * @param  string $option
1364
	 * @return boolean
1365
	 */
1366
	public function is_multisite( $option ) {
1367
		return (string) (bool) is_multisite();
1368
	}
1369
1370
	/**
1371
	 * Implemented since there is no core is multi network function
1372
	 * Right now there is no way to tell if we which network is the dominant network on the system
1373
	 *
1374
	 * @since  3.3
1375
	 * @return boolean
1376
	 */
1377 View Code Duplication
	public static function is_multi_network() {
1378
		global  $wpdb;
1379
1380
		// if we don't have a multi site setup no need to do any more
1381
		if ( ! is_multisite() ) {
1382
			return false;
1383
		}
1384
1385
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1386
		if ( $num_sites > 1 ) {
1387
			return true;
1388
		} else {
1389
			return false;
1390
		}
1391
	}
1392
1393
	/**
1394
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1395
	 *
1396
	 * @return null
1397
	 */
1398
	function update_jetpack_main_network_site_option() {
1399
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1400
	}
1401
	/**
1402
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1403
	 */
1404
	function update_jetpack_network_settings() {
1405
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1406
		// Only sync this info for the main network site.
1407
	}
1408
1409
	/**
1410
	 * Get back if the current site is single user site.
1411
	 *
1412
	 * @return bool
1413
	 */
1414 View Code Duplication
	public static function is_single_user_site() {
1415
		global $wpdb;
1416
1417
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1418
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1419
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1420
		}
1421
		return 1 === (int) $some_users;
1422
	}
1423
1424
	/**
1425
	 * Returns true if the site has file write access false otherwise.
1426
	 *
1427
	 * @return string ( '1' | '0' )
1428
	 **/
1429
	public static function file_system_write_access() {
1430
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1431
			require_once ABSPATH . 'wp-admin/includes/file.php';
1432
		}
1433
1434
		require_once ABSPATH . 'wp-admin/includes/template.php';
1435
1436
		$filesystem_method = get_filesystem_method();
1437
		if ( $filesystem_method === 'direct' ) {
1438
			return 1;
1439
		}
1440
1441
		ob_start();
1442
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1443
		ob_end_clean();
1444
		if ( $filesystem_credentials_are_stored ) {
1445
			return 1;
1446
		}
1447
		return 0;
1448
	}
1449
1450
	/**
1451
	 * Finds out if a site is using a version control system.
1452
	 *
1453
	 * @return string ( '1' | '0' )
1454
	 **/
1455
	public static function is_version_controlled() {
1456
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1457
		return (string) (int) Functions::is_version_controlled();
1458
	}
1459
1460
	/**
1461
	 * Determines whether the current theme supports featured images or not.
1462
	 *
1463
	 * @return string ( '1' | '0' )
1464
	 */
1465
	public static function featured_images_enabled() {
1466
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1467
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1468
	}
1469
1470
	/**
1471
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1472
	 *
1473
	 * @deprecated 4.7 use get_avatar_url instead.
1474
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1475
	 * @param int               $size Size of the avatar image
1476
	 * @param string            $default URL to a default image to use if no avatar is available
1477
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1478
	 *
1479
	 * @return array
1480
	 */
1481
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1482
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1483
		return get_avatar_url(
1484
			$id_or_email,
1485
			array(
1486
				'size'          => $size,
1487
				'default'       => $default,
1488
				'force_default' => $force_display,
1489
			)
1490
		);
1491
	}
1492
1493
	/**
1494
	 * jetpack_updates is saved in the following schema:
1495
	 *
1496
	 * array (
1497
	 *      'plugins'                       => (int) Number of plugin updates available.
1498
	 *      'themes'                        => (int) Number of theme updates available.
1499
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1500
	 *      'translations'                  => (int) Number of translation updates available.
1501
	 *      'total'                         => (int) Total of all available updates.
1502
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1503
	 * )
1504
	 *
1505
	 * @return array
1506
	 */
1507
	public static function get_updates() {
1508
		$update_data = wp_get_update_data();
1509
1510
		// Stores the individual update counts as well as the total count.
1511
		if ( isset( $update_data['counts'] ) ) {
1512
			$updates = $update_data['counts'];
1513
		}
1514
1515
		// If we need to update WordPress core, let's find the latest version number.
1516 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1517
			$cur = get_preferred_from_update_core();
1518
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1519
				$updates['wp_update_version'] = $cur->current;
1520
			}
1521
		}
1522
		return isset( $updates ) ? $updates : array();
1523
	}
1524
1525
	public static function get_update_details() {
1526
		$update_details = array(
1527
			'update_core'    => get_site_transient( 'update_core' ),
1528
			'update_plugins' => get_site_transient( 'update_plugins' ),
1529
			'update_themes'  => get_site_transient( 'update_themes' ),
1530
		);
1531
		return $update_details;
1532
	}
1533
1534
	public static function refresh_update_data() {
1535
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1536
1537
	}
1538
1539
	public static function refresh_theme_data() {
1540
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1541
	}
1542
1543
	/**
1544
	 * Is Jetpack active?
1545
	 */
1546
	public static function is_active() {
1547
		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...
1548
	}
1549
1550
	/**
1551
	 * Make an API call to WordPress.com for plan status
1552
	 *
1553
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1554
	 *
1555
	 * @return bool True if plan is updated, false if no update
1556
	 */
1557
	public static function refresh_active_plan_from_wpcom() {
1558
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1559
		return Jetpack_Plan::refresh_from_wpcom();
1560
	}
1561
1562
	/**
1563
	 * Get the plan that this Jetpack site is currently using
1564
	 *
1565
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1566
	 * @return array Active Jetpack plan details.
1567
	 */
1568
	public static function get_active_plan() {
1569
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1570
		return Jetpack_Plan::get();
1571
	}
1572
1573
	/**
1574
	 * Determine whether the active plan supports a particular feature
1575
	 *
1576
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1577
	 * @return bool True if plan supports feature, false if not.
1578
	 */
1579
	public static function active_plan_supports( $feature ) {
1580
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1581
		return Jetpack_Plan::supports( $feature );
1582
	}
1583
1584
	/**
1585
	 * Deprecated: Is Jetpack in development (offline) mode?
1586
	 *
1587
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1588
	 * and themes still use it, and we do not want to flood them with notices.
1589
	 *
1590
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1591
	 *
1592
	 * @deprecated since 8.0.
1593
	 */
1594
	public static function is_development_mode() {
1595
		return ( new Status() )->is_development_mode();
1596
	}
1597
1598
	/**
1599
	 * Whether the site is currently onboarding or not.
1600
	 * A site is considered as being onboarded if it currently has an onboarding token.
1601
	 *
1602
	 * @since 5.8
1603
	 *
1604
	 * @access public
1605
	 * @static
1606
	 *
1607
	 * @return bool True if the site is currently onboarding, false otherwise
1608
	 */
1609
	public static function is_onboarding() {
1610
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1611
	}
1612
1613
	/**
1614
	 * Determines reason for Jetpack development mode.
1615
	 */
1616
	public static function development_mode_trigger_text() {
1617
		if ( ! ( new Status() )->is_development_mode() ) {
1618
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1619
		}
1620
1621
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1622
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1623
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1624
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1625
		} else {
1626
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1627
		}
1628
1629
		return $notice;
1630
1631
	}
1632
	/**
1633
	 * Get Jetpack development mode notice text and notice class.
1634
	 *
1635
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1636
	 */
1637
	public static function show_development_mode_notice() {
1638 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1639
			$notice = sprintf(
1640
				/* translators: %s is a URL */
1641
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1642
				'https://jetpack.com/support/development-mode/'
1643
			);
1644
1645
			$notice .= ' ' . self::development_mode_trigger_text();
1646
1647
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1648
		}
1649
1650
		// Throw up a notice if using a development version and as for feedback.
1651
		if ( self::is_development_version() ) {
1652
			/* translators: %s is a URL */
1653
			$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/' );
1654
1655
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1656
		}
1657
		// Throw up a notice if using staging mode
1658
		if ( self::is_staging_site() ) {
1659
			/* translators: %s is a URL */
1660
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1661
1662
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1663
		}
1664
	}
1665
1666
	/**
1667
	 * Whether Jetpack's version maps to a public release, or a development version.
1668
	 */
1669
	public static function is_development_version() {
1670
		/**
1671
		 * Allows filtering whether this is a development version of Jetpack.
1672
		 *
1673
		 * This filter is especially useful for tests.
1674
		 *
1675
		 * @since 4.3.0
1676
		 *
1677
		 * @param bool $development_version Is this a develoment version of Jetpack?
1678
		 */
1679
		return (bool) apply_filters(
1680
			'jetpack_development_version',
1681
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1682
		);
1683
	}
1684
1685
	/**
1686
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1687
	 */
1688
	public static function is_user_connected( $user_id = false ) {
1689
		return self::connection()->is_user_connected( $user_id );
1690
	}
1691
1692
	/**
1693
	 * Get the wpcom user data of the current|specified connected user.
1694
	 */
1695 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1696
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1697
		if ( ! $user_id ) {
1698
			$user_id = get_current_user_id();
1699
		}
1700
1701
		$transient_key = "jetpack_connected_user_data_$user_id";
1702
1703
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1704
			return $cached_user_data;
1705
		}
1706
1707
		$xml = new Jetpack_IXR_Client(
1708
			array(
1709
				'user_id' => $user_id,
1710
			)
1711
		);
1712
		$xml->query( 'wpcom.getUser' );
1713
		if ( ! $xml->isError() ) {
1714
			$user_data = $xml->getResponse();
1715
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1716
			return $user_data;
1717
		}
1718
1719
		return false;
1720
	}
1721
1722
	/**
1723
	 * Get the wpcom email of the current|specified connected user.
1724
	 */
1725 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1726
		if ( ! $user_id ) {
1727
			$user_id = get_current_user_id();
1728
		}
1729
1730
		$xml = new Jetpack_IXR_Client(
1731
			array(
1732
				'user_id' => $user_id,
1733
			)
1734
		);
1735
		$xml->query( 'wpcom.getUserEmail' );
1736
		if ( ! $xml->isError() ) {
1737
			return $xml->getResponse();
1738
		}
1739
		return false;
1740
	}
1741
1742
	/**
1743
	 * Get the wpcom email of the master user.
1744
	 */
1745
	public static function get_master_user_email() {
1746
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1747
		if ( $master_user_id ) {
1748
			return self::get_connected_user_email( $master_user_id );
1749
		}
1750
		return '';
1751
	}
1752
1753
	/**
1754
	 * Whether the current user is the connection owner.
1755
	 *
1756
	 * @deprecated since 7.7
1757
	 *
1758
	 * @return bool Whether the current user is the connection owner.
1759
	 */
1760
	public function current_user_is_connection_owner() {
1761
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1762
		return self::connection()->is_connection_owner();
1763
	}
1764
1765
	/**
1766
	 * Gets current user IP address.
1767
	 *
1768
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1769
	 *
1770
	 * @return string                  Current user IP address.
1771
	 */
1772
	public static function current_user_ip( $check_all_headers = false ) {
1773
		if ( $check_all_headers ) {
1774
			foreach ( array(
1775
				'HTTP_CF_CONNECTING_IP',
1776
				'HTTP_CLIENT_IP',
1777
				'HTTP_X_FORWARDED_FOR',
1778
				'HTTP_X_FORWARDED',
1779
				'HTTP_X_CLUSTER_CLIENT_IP',
1780
				'HTTP_FORWARDED_FOR',
1781
				'HTTP_FORWARDED',
1782
				'HTTP_VIA',
1783
			) as $key ) {
1784
				if ( ! empty( $_SERVER[ $key ] ) ) {
1785
					return $_SERVER[ $key ];
1786
				}
1787
			}
1788
		}
1789
1790
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1791
	}
1792
1793
	/**
1794
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1795
	 */
1796
	function extra_oembed_providers() {
1797
		// Cloudup: https://dev.cloudup.com/#oembed
1798
		wp_oembed_add_provider( 'https://cloudup.com/*', 'https://cloudup.com/oembed' );
1799
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1800
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1801
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1802
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1803
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1804
		wp_oembed_add_provider( 'https://song.link/*', 'https://song.link/oembed', false );
1805
	}
1806
1807
	/**
1808
	 * Synchronize connected user role changes
1809
	 */
1810
	function user_role_change( $user_id ) {
1811
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1812
		Users::user_role_change( $user_id );
1813
	}
1814
1815
	/**
1816
	 * Loads the currently active modules.
1817
	 */
1818
	public static function load_modules() {
1819
		$is_development_mode = ( new Status() )->is_development_mode();
1820
		if (
1821
			! self::is_active()
1822
			&& ! $is_development_mode
1823
			&& ! self::is_onboarding()
1824
			&& (
1825
				! is_multisite()
1826
				|| ! get_site_option( 'jetpack_protect_active' )
1827
			)
1828
		) {
1829
			return;
1830
		}
1831
1832
		$version = Jetpack_Options::get_option( 'version' );
1833 View Code Duplication
		if ( ! $version ) {
1834
			$version = $old_version = JETPACK__VERSION . ':' . time();
1835
			/** This action is documented in class.jetpack.php */
1836
			do_action( 'updating_jetpack_version', $version, false );
1837
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1838
		}
1839
		list( $version ) = explode( ':', $version );
1840
1841
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1842
1843
		$modules_data = array();
1844
1845
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1846
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1847
			$updated_modules = array();
1848
			foreach ( $modules as $module ) {
1849
				$modules_data[ $module ] = self::get_module( $module );
1850
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1851
					continue;
1852
				}
1853
1854
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1855
					continue;
1856
				}
1857
1858
				$updated_modules[] = $module;
1859
			}
1860
1861
			$modules = array_diff( $modules, $updated_modules );
1862
		}
1863
1864
		foreach ( $modules as $index => $module ) {
1865
			// If we're in dev mode, disable modules requiring a connection
1866
			if ( $is_development_mode ) {
1867
				// Prime the pump if we need to
1868
				if ( empty( $modules_data[ $module ] ) ) {
1869
					$modules_data[ $module ] = self::get_module( $module );
1870
				}
1871
				// If the module requires a connection, but we're in local mode, don't include it.
1872
				if ( $modules_data[ $module ]['requires_connection'] ) {
1873
					continue;
1874
				}
1875
			}
1876
1877
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1878
				continue;
1879
			}
1880
1881
			if ( ! include_once self::get_module_path( $module ) ) {
1882
				unset( $modules[ $index ] );
1883
				self::update_active_modules( array_values( $modules ) );
1884
				continue;
1885
			}
1886
1887
			/**
1888
			 * Fires when a specific module is loaded.
1889
			 * The dynamic part of the hook, $module, is the module slug.
1890
			 *
1891
			 * @since 1.1.0
1892
			 */
1893
			do_action( 'jetpack_module_loaded_' . $module );
1894
		}
1895
1896
		/**
1897
		 * Fires when all the modules are loaded.
1898
		 *
1899
		 * @since 1.1.0
1900
		 */
1901
		do_action( 'jetpack_modules_loaded' );
1902
1903
		// 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.
1904
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1905
	}
1906
1907
	/**
1908
	 * Check if Jetpack's REST API compat file should be included
1909
	 *
1910
	 * @action plugins_loaded
1911
	 * @return null
1912
	 */
1913
	public function check_rest_api_compat() {
1914
		/**
1915
		 * Filters the list of REST API compat files to be included.
1916
		 *
1917
		 * @since 2.2.5
1918
		 *
1919
		 * @param array $args Array of REST API compat files to include.
1920
		 */
1921
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1922
1923
		if ( function_exists( 'bbpress' ) ) {
1924
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1925
		}
1926
1927
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1928
			require_once $_jetpack_rest_api_compat_include;
1929
		}
1930
	}
1931
1932
	/**
1933
	 * Gets all plugins currently active in values, regardless of whether they're
1934
	 * traditionally activated or network activated.
1935
	 *
1936
	 * @todo Store the result in core's object cache maybe?
1937
	 */
1938
	public static function get_active_plugins() {
1939
		$active_plugins = (array) get_option( 'active_plugins', array() );
1940
1941
		if ( is_multisite() ) {
1942
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1943
			// whereas active_plugins stores them in the values.
1944
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1945
			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...
1946
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1947
			}
1948
		}
1949
1950
		sort( $active_plugins );
1951
1952
		return array_unique( $active_plugins );
1953
	}
1954
1955
	/**
1956
	 * Gets and parses additional plugin data to send with the heartbeat data
1957
	 *
1958
	 * @since 3.8.1
1959
	 *
1960
	 * @return array Array of plugin data
1961
	 */
1962
	public static function get_parsed_plugin_data() {
1963
		if ( ! function_exists( 'get_plugins' ) ) {
1964
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
1965
		}
1966
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1967
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1968
		$active_plugins = self::get_active_plugins();
1969
1970
		$plugins = array();
1971
		foreach ( $all_plugins as $path => $plugin_data ) {
1972
			$plugins[ $path ] = array(
1973
				'is_active' => in_array( $path, $active_plugins ),
1974
				'file'      => $path,
1975
				'name'      => $plugin_data['Name'],
1976
				'version'   => $plugin_data['Version'],
1977
				'author'    => $plugin_data['Author'],
1978
			);
1979
		}
1980
1981
		return $plugins;
1982
	}
1983
1984
	/**
1985
	 * Gets and parses theme data to send with the heartbeat data
1986
	 *
1987
	 * @since 3.8.1
1988
	 *
1989
	 * @return array Array of theme data
1990
	 */
1991
	public static function get_parsed_theme_data() {
1992
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
1993
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1994
1995
		$themes = array();
1996
		foreach ( $all_themes as $slug => $theme_data ) {
1997
			$theme_headers = array();
1998
			foreach ( $header_keys as $header_key ) {
1999
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2000
			}
2001
2002
			$themes[ $slug ] = array(
2003
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2004
				'slug'            => $slug,
2005
				'theme_root'      => $theme_data->get_theme_root_uri(),
2006
				'parent'          => $theme_data->parent(),
2007
				'headers'         => $theme_headers,
2008
			);
2009
		}
2010
2011
		return $themes;
2012
	}
2013
2014
	/**
2015
	 * Checks whether a specific plugin is active.
2016
	 *
2017
	 * We don't want to store these in a static variable, in case
2018
	 * there are switch_to_blog() calls involved.
2019
	 */
2020
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2021
		return in_array( $plugin, self::get_active_plugins() );
2022
	}
2023
2024
	/**
2025
	 * Check if Jetpack's Open Graph tags should be used.
2026
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2027
	 *
2028
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2029
	 * @action plugins_loaded
2030
	 * @return null
2031
	 */
2032
	public function check_open_graph() {
2033
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2034
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2035
		}
2036
2037
		$active_plugins = self::get_active_plugins();
2038
2039
		if ( ! empty( $active_plugins ) ) {
2040
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2041
				if ( in_array( $plugin, $active_plugins ) ) {
2042
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2043
					break;
2044
				}
2045
			}
2046
		}
2047
2048
		/**
2049
		 * Allow the addition of Open Graph Meta Tags to all pages.
2050
		 *
2051
		 * @since 2.0.3
2052
		 *
2053
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2054
		 */
2055
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2056
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2057
		}
2058
	}
2059
2060
	/**
2061
	 * Check if Jetpack's Twitter tags should be used.
2062
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2063
	 *
2064
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2065
	 * @action plugins_loaded
2066
	 * @return null
2067
	 */
2068
	public function check_twitter_tags() {
2069
2070
		$active_plugins = self::get_active_plugins();
2071
2072
		if ( ! empty( $active_plugins ) ) {
2073
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2074
				if ( in_array( $plugin, $active_plugins ) ) {
2075
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2076
					break;
2077
				}
2078
			}
2079
		}
2080
2081
		/**
2082
		 * Allow Twitter Card Meta tags to be disabled.
2083
		 *
2084
		 * @since 2.6.0
2085
		 *
2086
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2087
		 */
2088
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2089
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2090
		}
2091
	}
2092
2093
	/**
2094
	 * Allows plugins to submit security reports.
2095
	 *
2096
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2097
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2098
	 * @param array  $args         See definitions above
2099
	 */
2100
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2101
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2102
	}
2103
2104
	/* Jetpack Options API */
2105
2106
	public static function get_option_names( $type = 'compact' ) {
2107
		return Jetpack_Options::get_option_names( $type );
2108
	}
2109
2110
	/**
2111
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2112
	 *
2113
	 * @param string $name    Option name
2114
	 * @param mixed  $default (optional)
2115
	 */
2116
	public static function get_option( $name, $default = false ) {
2117
		return Jetpack_Options::get_option( $name, $default );
2118
	}
2119
2120
	/**
2121
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2122
	 *
2123
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2124
	 * @param string $name  Option name
2125
	 * @param mixed  $value Option value
2126
	 */
2127
	public static function update_option( $name, $value ) {
2128
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2129
		return Jetpack_Options::update_option( $name, $value );
2130
	}
2131
2132
	/**
2133
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2134
	 *
2135
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2136
	 * @param array $array array( option name => option value, ... )
2137
	 */
2138
	public static function update_options( $array ) {
2139
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2140
		return Jetpack_Options::update_options( $array );
2141
	}
2142
2143
	/**
2144
	 * Deletes the given option.  May be passed multiple option names as an array.
2145
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2146
	 *
2147
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2148
	 * @param string|array $names
2149
	 */
2150
	public static function delete_option( $names ) {
2151
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2152
		return Jetpack_Options::delete_option( $names );
2153
	}
2154
2155
	/**
2156
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2157
	 *
2158
	 * Enters a user token into the user_tokens option
2159
	 *
2160
	 * @param int    $user_id The user id.
2161
	 * @param string $token The user token.
2162
	 * @param bool   $is_master_user Whether the user is the master user.
2163
	 * @return bool
2164
	 */
2165
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2166
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2167
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2168
	}
2169
2170
	/**
2171
	 * Returns an array of all PHP files in the specified absolute path.
2172
	 * Equivalent to glob( "$absolute_path/*.php" ).
2173
	 *
2174
	 * @param string $absolute_path The absolute path of the directory to search.
2175
	 * @return array Array of absolute paths to the PHP files.
2176
	 */
2177
	public static function glob_php( $absolute_path ) {
2178
		if ( function_exists( 'glob' ) ) {
2179
			return glob( "$absolute_path/*.php" );
2180
		}
2181
2182
		$absolute_path = untrailingslashit( $absolute_path );
2183
		$files         = array();
2184
		if ( ! $dir = @opendir( $absolute_path ) ) {
2185
			return $files;
2186
		}
2187
2188
		while ( false !== $file = readdir( $dir ) ) {
2189
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2190
				continue;
2191
			}
2192
2193
			$file = "$absolute_path/$file";
2194
2195
			if ( ! is_file( $file ) ) {
2196
				continue;
2197
			}
2198
2199
			$files[] = $file;
2200
		}
2201
2202
		closedir( $dir );
2203
2204
		return $files;
2205
	}
2206
2207
	public static function activate_new_modules( $redirect = false ) {
2208
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2209
			return;
2210
		}
2211
2212
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2213 View Code Duplication
		if ( ! $jetpack_old_version ) {
2214
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2215
			/** This action is documented in class.jetpack.php */
2216
			do_action( 'updating_jetpack_version', $version, false );
2217
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2218
		}
2219
2220
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2221
2222
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2223
			return;
2224
		}
2225
2226
		$active_modules     = self::get_active_modules();
2227
		$reactivate_modules = array();
2228
		foreach ( $active_modules as $active_module ) {
2229
			$module = self::get_module( $active_module );
2230
			if ( ! isset( $module['changed'] ) ) {
2231
				continue;
2232
			}
2233
2234
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2235
				continue;
2236
			}
2237
2238
			$reactivate_modules[] = $active_module;
2239
			self::deactivate_module( $active_module );
2240
		}
2241
2242
		$new_version = JETPACK__VERSION . ':' . time();
2243
		/** This action is documented in class.jetpack.php */
2244
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2245
		Jetpack_Options::update_options(
2246
			array(
2247
				'version'     => $new_version,
2248
				'old_version' => $jetpack_old_version,
2249
			)
2250
		);
2251
2252
		self::state( 'message', 'modules_activated' );
2253
		self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2254
2255
		if ( $redirect ) {
2256
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2257
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2258
				$page = $_GET['page'];
2259
			}
2260
2261
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2262
			exit;
2263
		}
2264
	}
2265
2266
	/**
2267
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2268
	 * Make sure to tuck away module "library" files in a sub-directory.
2269
	 */
2270
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2271
		static $modules = null;
2272
2273
		if ( ! isset( $modules ) ) {
2274
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2275
			// Use the cache if we're on the front-end and it's available...
2276
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2277
				$modules = $available_modules_option[ JETPACK__VERSION ];
2278
			} else {
2279
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2280
2281
				$modules = array();
2282
2283
				foreach ( $files as $file ) {
2284
					if ( ! $headers = self::get_module( $file ) ) {
2285
						continue;
2286
					}
2287
2288
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2289
				}
2290
2291
				Jetpack_Options::update_option(
2292
					'available_modules',
2293
					array(
2294
						JETPACK__VERSION => $modules,
2295
					)
2296
				);
2297
			}
2298
		}
2299
2300
		/**
2301
		 * Filters the array of modules available to be activated.
2302
		 *
2303
		 * @since 2.4.0
2304
		 *
2305
		 * @param array $modules Array of available modules.
2306
		 * @param string $min_version Minimum version number required to use modules.
2307
		 * @param string $max_version Maximum version number required to use modules.
2308
		 */
2309
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2310
2311
		if ( ! $min_version && ! $max_version ) {
2312
			return array_keys( $mods );
2313
		}
2314
2315
		$r = array();
2316
		foreach ( $mods as $slug => $introduced ) {
2317
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2318
				continue;
2319
			}
2320
2321
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2322
				continue;
2323
			}
2324
2325
			$r[] = $slug;
2326
		}
2327
2328
		return $r;
2329
	}
2330
2331
	/**
2332
	 * Default modules loaded on activation.
2333
	 */
2334
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2335
		$return = array();
2336
2337
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2338
			$module_data = self::get_module( $module );
2339
2340
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2341
				case 'yes':
2342
					$return[] = $module;
2343
					break;
2344
				case 'public':
2345
					if ( Jetpack_Options::get_option( 'public' ) ) {
2346
						$return[] = $module;
2347
					}
2348
					break;
2349
				case 'no':
2350
				default:
2351
					break;
2352
			}
2353
		}
2354
		/**
2355
		 * Filters the array of default modules.
2356
		 *
2357
		 * @since 2.5.0
2358
		 *
2359
		 * @param array $return Array of default modules.
2360
		 * @param string $min_version Minimum version number required to use modules.
2361
		 * @param string $max_version Maximum version number required to use modules.
2362
		 */
2363
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2364
	}
2365
2366
	/**
2367
	 * Checks activated modules during auto-activation to determine
2368
	 * if any of those modules are being deprecated.  If so, close
2369
	 * them out, and add any replacement modules.
2370
	 *
2371
	 * Runs at priority 99 by default.
2372
	 *
2373
	 * This is run late, so that it can still activate a module if
2374
	 * the new module is a replacement for another that the user
2375
	 * currently has active, even if something at the normal priority
2376
	 * would kibosh everything.
2377
	 *
2378
	 * @since 2.6
2379
	 * @uses jetpack_get_default_modules filter
2380
	 * @param array $modules
2381
	 * @return array
2382
	 */
2383
	function handle_deprecated_modules( $modules ) {
2384
		$deprecated_modules = array(
2385
			'debug'            => null,  // Closed out and moved to the debugger library.
2386
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2387
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2388
		);
2389
2390
		// Don't activate SSO if they never completed activating WPCC.
2391
		if ( self::is_module_active( 'wpcc' ) ) {
2392
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2393
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2394
				$deprecated_modules['wpcc'] = null;
2395
			}
2396
		}
2397
2398
		foreach ( $deprecated_modules as $module => $replacement ) {
2399
			if ( self::is_module_active( $module ) ) {
2400
				self::deactivate_module( $module );
2401
				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...
2402
					$modules[] = $replacement;
2403
				}
2404
			}
2405
		}
2406
2407
		return array_unique( $modules );
2408
	}
2409
2410
	/**
2411
	 * Checks activated plugins during auto-activation to determine
2412
	 * if any of those plugins are in the list with a corresponding module
2413
	 * that is not compatible with the plugin. The module will not be allowed
2414
	 * to auto-activate.
2415
	 *
2416
	 * @since 2.6
2417
	 * @uses jetpack_get_default_modules filter
2418
	 * @param array $modules
2419
	 * @return array
2420
	 */
2421
	function filter_default_modules( $modules ) {
2422
2423
		$active_plugins = self::get_active_plugins();
2424
2425
		if ( ! empty( $active_plugins ) ) {
2426
2427
			// For each module we'd like to auto-activate...
2428
			foreach ( $modules as $key => $module ) {
2429
				// If there are potential conflicts for it...
2430
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2431
					// For each potential conflict...
2432
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2433
						// If that conflicting plugin is active...
2434
						if ( in_array( $plugin, $active_plugins ) ) {
2435
							// Remove that item from being auto-activated.
2436
							unset( $modules[ $key ] );
2437
						}
2438
					}
2439
				}
2440
			}
2441
		}
2442
2443
		return $modules;
2444
	}
2445
2446
	/**
2447
	 * Extract a module's slug from its full path.
2448
	 */
2449
	public static function get_module_slug( $file ) {
2450
		return str_replace( '.php', '', basename( $file ) );
2451
	}
2452
2453
	/**
2454
	 * Generate a module's path from its slug.
2455
	 */
2456
	public static function get_module_path( $slug ) {
2457
		/**
2458
		 * Filters the path of a modules.
2459
		 *
2460
		 * @since 7.4.0
2461
		 *
2462
		 * @param array $return The absolute path to a module's root php file
2463
		 * @param string $slug The module slug
2464
		 */
2465
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2466
	}
2467
2468
	/**
2469
	 * Load module data from module file. Headers differ from WordPress
2470
	 * plugin headers to avoid them being identified as standalone
2471
	 * plugins on the WordPress plugins page.
2472
	 */
2473
	public static function get_module( $module ) {
2474
		$headers = array(
2475
			'name'                      => 'Module Name',
2476
			'description'               => 'Module Description',
2477
			'sort'                      => 'Sort Order',
2478
			'recommendation_order'      => 'Recommendation Order',
2479
			'introduced'                => 'First Introduced',
2480
			'changed'                   => 'Major Changes In',
2481
			'deactivate'                => 'Deactivate',
2482
			'free'                      => 'Free',
2483
			'requires_connection'       => 'Requires Connection',
2484
			'auto_activate'             => 'Auto Activate',
2485
			'module_tags'               => 'Module Tags',
2486
			'feature'                   => 'Feature',
2487
			'additional_search_queries' => 'Additional Search Queries',
2488
			'plan_classes'              => 'Plans',
2489
		);
2490
2491
		$file = self::get_module_path( self::get_module_slug( $module ) );
2492
2493
		$mod = self::get_file_data( $file, $headers );
2494
		if ( empty( $mod['name'] ) ) {
2495
			return false;
2496
		}
2497
2498
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2499
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2500
		$mod['deactivate']           = empty( $mod['deactivate'] );
2501
		$mod['free']                 = empty( $mod['free'] );
2502
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2503
2504
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2505
			$mod['auto_activate'] = 'No';
2506
		} else {
2507
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2508
		}
2509
2510
		if ( $mod['module_tags'] ) {
2511
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2512
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2513
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2514
		} else {
2515
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2516
		}
2517
2518 View Code Duplication
		if ( $mod['plan_classes'] ) {
2519
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2520
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2521
		} else {
2522
			$mod['plan_classes'] = array( 'free' );
2523
		}
2524
2525 View Code Duplication
		if ( $mod['feature'] ) {
2526
			$mod['feature'] = explode( ',', $mod['feature'] );
2527
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2528
		} else {
2529
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2530
		}
2531
2532
		/**
2533
		 * Filters the feature array on a module.
2534
		 *
2535
		 * This filter allows you to control where each module is filtered: Recommended,
2536
		 * and the default "Other" listing.
2537
		 *
2538
		 * @since 3.5.0
2539
		 *
2540
		 * @param array   $mod['feature'] The areas to feature this module:
2541
		 *     'Recommended' shows on the main Jetpack admin screen.
2542
		 *     'Other' should be the default if no other value is in the array.
2543
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2544
		 * @param array   $mod All the currently assembled module data.
2545
		 */
2546
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2547
2548
		/**
2549
		 * Filter the returned data about a module.
2550
		 *
2551
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2552
		 * so please be careful.
2553
		 *
2554
		 * @since 3.6.0
2555
		 *
2556
		 * @param array   $mod    The details of the requested module.
2557
		 * @param string  $module The slug of the module, e.g. sharedaddy
2558
		 * @param string  $file   The path to the module source file.
2559
		 */
2560
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2561
	}
2562
2563
	/**
2564
	 * Like core's get_file_data implementation, but caches the result.
2565
	 */
2566
	public static function get_file_data( $file, $headers ) {
2567
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2568
		$file_name = basename( $file );
2569
2570
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2571
2572
		$file_data_option = get_transient( $cache_key );
2573
2574
		if ( ! is_array( $file_data_option ) ) {
2575
			delete_transient( $cache_key );
2576
			$file_data_option = false;
2577
		}
2578
2579
		if ( false === $file_data_option ) {
2580
			$file_data_option = array();
2581
		}
2582
2583
		$key           = md5( $file_name . serialize( $headers ) );
2584
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2585
2586
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2587
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2588
			return $file_data_option[ $key ];
2589
		}
2590
2591
		$data = get_file_data( $file, $headers );
2592
2593
		$file_data_option[ $key ] = $data;
2594
2595
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2596
2597
		return $data;
2598
	}
2599
2600
2601
	/**
2602
	 * Return translated module tag.
2603
	 *
2604
	 * @param string $tag Tag as it appears in each module heading.
2605
	 *
2606
	 * @return mixed
2607
	 */
2608
	public static function translate_module_tag( $tag ) {
2609
		return jetpack_get_module_i18n_tag( $tag );
2610
	}
2611
2612
	/**
2613
	 * Get i18n strings as a JSON-encoded string
2614
	 *
2615
	 * @return string The locale as JSON
2616
	 */
2617
	public static function get_i18n_data_json() {
2618
2619
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2620
		// JSON files with the file they should be included for. This is an md5
2621
		// of '_inc/build/admin.js'.
2622
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2623
2624
		$i18n_json =
2625
				   JETPACK__PLUGIN_DIR
2626
				   . 'languages/json/jetpack-'
2627
				   . get_user_locale()
2628
				   . '-'
2629
				   . $path_md5
2630
				   . '.json';
2631
2632
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2633
			$locale_data = @file_get_contents( $i18n_json );
2634
			if ( $locale_data ) {
2635
				return $locale_data;
2636
			}
2637
		}
2638
2639
		// Return valid empty Jed locale
2640
		return '{ "locale_data": { "messages": { "": {} } } }';
2641
	}
2642
2643
	/**
2644
	 * Add locale data setup to wp-i18n
2645
	 *
2646
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2647
	 *
2648
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2649
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2650
	 *
2651
	 * This method provides a safe way to request the setup multiple times but add the script at
2652
	 * most once.
2653
	 *
2654
	 * @since 6.7.0
2655
	 *
2656
	 * @return void
2657
	 */
2658
	public static function setup_wp_i18n_locale_data() {
2659
		static $script_added = false;
2660
		if ( ! $script_added ) {
2661
			$script_added = true;
2662
			wp_add_inline_script(
2663
				'wp-i18n',
2664
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2665
			);
2666
		}
2667
	}
2668
2669
	/**
2670
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2671
	 *
2672
	 * @since 3.9.2
2673
	 *
2674
	 * @param array $modules
2675
	 *
2676
	 * @return string|void
2677
	 */
2678
	public static function get_translated_modules( $modules ) {
2679
		foreach ( $modules as $index => $module ) {
2680
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2681
			if ( isset( $module['name'] ) ) {
2682
				$modules[ $index ]['name'] = $i18n_module['name'];
2683
			}
2684
			if ( isset( $module['description'] ) ) {
2685
				$modules[ $index ]['description']       = $i18n_module['description'];
2686
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2687
			}
2688
		}
2689
		return $modules;
2690
	}
2691
2692
	/**
2693
	 * Get a list of activated modules as an array of module slugs.
2694
	 */
2695
	public static function get_active_modules() {
2696
		$active = Jetpack_Options::get_option( 'active_modules' );
2697
2698
		if ( ! is_array( $active ) ) {
2699
			$active = array();
2700
		}
2701
2702
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2703
			$active[] = 'vaultpress';
2704
		} else {
2705
			$active = array_diff( $active, array( 'vaultpress' ) );
2706
		}
2707
2708
		// If protect is active on the main site of a multisite, it should be active on all sites.
2709
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2710
			$active[] = 'protect';
2711
		}
2712
2713
		/**
2714
		 * Allow filtering of the active modules.
2715
		 *
2716
		 * Gives theme and plugin developers the power to alter the modules that
2717
		 * are activated on the fly.
2718
		 *
2719
		 * @since 5.8.0
2720
		 *
2721
		 * @param array $active Array of active module slugs.
2722
		 */
2723
		$active = apply_filters( 'jetpack_active_modules', $active );
2724
2725
		return array_unique( $active );
2726
	}
2727
2728
	/**
2729
	 * Check whether or not a Jetpack module is active.
2730
	 *
2731
	 * @param string $module The slug of a Jetpack module.
2732
	 * @return bool
2733
	 *
2734
	 * @static
2735
	 */
2736
	public static function is_module_active( $module ) {
2737
		return in_array( $module, self::get_active_modules() );
2738
	}
2739
2740
	public static function is_module( $module ) {
2741
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2742
	}
2743
2744
	/**
2745
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2746
	 *
2747
	 * @param bool $catch True to start catching, False to stop.
2748
	 *
2749
	 * @static
2750
	 */
2751
	public static function catch_errors( $catch ) {
2752
		static $display_errors, $error_reporting;
2753
2754
		if ( $catch ) {
2755
			$display_errors  = @ini_set( 'display_errors', 1 );
2756
			$error_reporting = @error_reporting( E_ALL );
2757
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2758
		} else {
2759
			@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...
2760
			@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...
2761
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2762
		}
2763
	}
2764
2765
	/**
2766
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2767
	 */
2768
	public static function catch_errors_on_shutdown() {
2769
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2770
	}
2771
2772
	/**
2773
	 * Rewrite any string to make paths easier to read.
2774
	 *
2775
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2776
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2777
	 *
2778
	 * @param $string
2779
	 * @return mixed
2780
	 */
2781
	public static function alias_directories( $string ) {
2782
		// ABSPATH has a trailing slash.
2783
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2784
		// WP_CONTENT_DIR does not have a trailing slash.
2785
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2786
2787
		return $string;
2788
	}
2789
2790
	public static function activate_default_modules(
2791
		$min_version = false,
2792
		$max_version = false,
2793
		$other_modules = array(),
2794
		$redirect = null,
2795
		$send_state_messages = null
2796
	) {
2797
		$jetpack = self::init();
2798
2799
		if ( is_null( $redirect ) ) {
2800
			if (
2801
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2802
			||
2803
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2804
			||
2805
				( defined( 'WP_CLI' ) && WP_CLI )
2806
			||
2807
				( defined( 'DOING_CRON' ) && DOING_CRON )
2808
			||
2809
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2810
			) {
2811
				$redirect = false;
2812
			} elseif ( is_admin() ) {
2813
				$redirect = true;
2814
			} else {
2815
				$redirect = false;
2816
			}
2817
		}
2818
2819
		if ( is_null( $send_state_messages ) ) {
2820
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2821
		}
2822
2823
		$modules = self::get_default_modules( $min_version, $max_version );
2824
		$modules = array_merge( $other_modules, $modules );
2825
2826
		// Look for standalone plugins and disable if active.
2827
2828
		$to_deactivate = array();
2829
		foreach ( $modules as $module ) {
2830
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2831
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2832
			}
2833
		}
2834
2835
		$deactivated = array();
2836
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2837
			list( $probable_file, $probable_title ) = $deactivate_me;
2838
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2839
				$deactivated[] = $module;
2840
			}
2841
		}
2842
2843
		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...
2844
			if ( $send_state_messages ) {
2845
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2846
			}
2847
2848
			if ( $redirect ) {
2849
				$url = add_query_arg(
2850
					array(
2851
						'action'   => 'activate_default_modules',
2852
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2853
					),
2854
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2855
				);
2856
				wp_safe_redirect( $url );
2857
				exit;
2858
			}
2859
		}
2860
2861
		/**
2862
		 * Fires before default modules are activated.
2863
		 *
2864
		 * @since 1.9.0
2865
		 *
2866
		 * @param string $min_version Minimum version number required to use modules.
2867
		 * @param string $max_version Maximum version number required to use modules.
2868
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2869
		 */
2870
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2871
2872
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2873
		if ( $send_state_messages ) {
2874
			self::restate();
2875
			self::catch_errors( true );
2876
		}
2877
2878
		$active = self::get_active_modules();
2879
2880
		foreach ( $modules as $module ) {
2881
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2882
				$active[] = $module;
2883
				self::update_active_modules( $active );
2884
				continue;
2885
			}
2886
2887
			if ( $send_state_messages && in_array( $module, $active ) ) {
2888
				$module_info = self::get_module( $module );
2889 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2890
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2891
					if ( $active_state = self::state( $state ) ) {
2892
						$active_state = explode( ',', $active_state );
2893
					} else {
2894
						$active_state = array();
2895
					}
2896
					$active_state[] = $module;
2897
					self::state( $state, implode( ',', $active_state ) );
2898
				}
2899
				continue;
2900
			}
2901
2902
			$file = self::get_module_path( $module );
2903
			if ( ! file_exists( $file ) ) {
2904
				continue;
2905
			}
2906
2907
			// we'll override this later if the plugin can be included without fatal error
2908
			if ( $redirect ) {
2909
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2910
			}
2911
2912
			if ( $send_state_messages ) {
2913
				self::state( 'error', 'module_activation_failed' );
2914
				self::state( 'module', $module );
2915
			}
2916
2917
			ob_start();
2918
			require_once $file;
2919
2920
			$active[] = $module;
2921
2922 View Code Duplication
			if ( $send_state_messages ) {
2923
2924
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2925
				if ( $active_state = self::state( $state ) ) {
2926
					$active_state = explode( ',', $active_state );
2927
				} else {
2928
					$active_state = array();
2929
				}
2930
				$active_state[] = $module;
2931
				self::state( $state, implode( ',', $active_state ) );
2932
			}
2933
2934
			self::update_active_modules( $active );
2935
2936
			ob_end_clean();
2937
		}
2938
2939
		if ( $send_state_messages ) {
2940
			self::state( 'error', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2941
			self::state( 'module', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2942
		}
2943
2944
		self::catch_errors( false );
2945
		/**
2946
		 * Fires when default modules are activated.
2947
		 *
2948
		 * @since 1.9.0
2949
		 *
2950
		 * @param string $min_version Minimum version number required to use modules.
2951
		 * @param string $max_version Maximum version number required to use modules.
2952
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2953
		 */
2954
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2955
	}
2956
2957
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2958
		/**
2959
		 * Fires before a module is activated.
2960
		 *
2961
		 * @since 2.6.0
2962
		 *
2963
		 * @param string $module Module slug.
2964
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2965
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2966
		 */
2967
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2968
2969
		$jetpack = self::init();
2970
2971
		if ( ! strlen( $module ) ) {
2972
			return false;
2973
		}
2974
2975
		if ( ! self::is_module( $module ) ) {
2976
			return false;
2977
		}
2978
2979
		// If it's already active, then don't do it again
2980
		$active = self::get_active_modules();
2981
		foreach ( $active as $act ) {
2982
			if ( $act == $module ) {
2983
				return true;
2984
			}
2985
		}
2986
2987
		$module_data = self::get_module( $module );
2988
2989
		$is_development_mode = ( new Status() )->is_development_mode();
2990
		if ( ! self::is_active() ) {
2991
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
2992
				return false;
2993
			}
2994
2995
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2996
			if ( $is_development_mode && $module_data['requires_connection'] ) {
2997
				return false;
2998
			}
2999
		}
3000
3001
		// Check and see if the old plugin is active
3002
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3003
			// Deactivate the old plugin
3004
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3005
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3006
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3007
				self::state( 'deactivated_plugins', $module );
3008
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3009
				exit;
3010
			}
3011
		}
3012
3013
		// Protect won't work with mis-configured IPs
3014
		if ( 'protect' === $module ) {
3015
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3016
			if ( ! jetpack_protect_get_ip() ) {
3017
				self::state( 'message', 'protect_misconfigured_ip' );
3018
				return false;
3019
			}
3020
		}
3021
3022
		if ( ! Jetpack_Plan::supports( $module ) ) {
3023
			return false;
3024
		}
3025
3026
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3027
		self::state( 'module', $module );
3028
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3029
3030
		self::catch_errors( true );
3031
		ob_start();
3032
		require self::get_module_path( $module );
3033
		/** This action is documented in class.jetpack.php */
3034
		do_action( 'jetpack_activate_module', $module );
3035
		$active[] = $module;
3036
		self::update_active_modules( $active );
3037
3038
		self::state( 'error', false ); // the override
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3039
		ob_end_clean();
3040
		self::catch_errors( false );
3041
3042
		if ( $redirect ) {
3043
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3044
		}
3045
		if ( $exit ) {
3046
			exit;
3047
		}
3048
		return true;
3049
	}
3050
3051
	function activate_module_actions( $module ) {
3052
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3053
	}
3054
3055
	public static function deactivate_module( $module ) {
3056
		/**
3057
		 * Fires when a module is deactivated.
3058
		 *
3059
		 * @since 1.9.0
3060
		 *
3061
		 * @param string $module Module slug.
3062
		 */
3063
		do_action( 'jetpack_pre_deactivate_module', $module );
3064
3065
		$jetpack = self::init();
0 ignored issues
show
Unused Code introduced by
$jetpack is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3066
3067
		$active = self::get_active_modules();
3068
		$new    = array_filter( array_diff( $active, (array) $module ) );
3069
3070
		return self::update_active_modules( $new );
3071
	}
3072
3073
	public static function enable_module_configurable( $module ) {
3074
		$module = self::get_module_slug( $module );
3075
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3076
	}
3077
3078
	/**
3079
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3080
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3081
	 *
3082
	 * @param string $module Module slug
3083
	 * @return string $url module configuration URL
3084
	 */
3085
	public static function module_configuration_url( $module ) {
3086
		$module      = self::get_module_slug( $module );
3087
		$default_url = self::admin_url() . "#/settings?term=$module";
3088
		/**
3089
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3090
		 *
3091
		 * @since 6.9.0
3092
		 *
3093
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3094
		 */
3095
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3096
3097
		return $url;
3098
	}
3099
3100
	/* Installation */
3101
	public static function bail_on_activation( $message, $deactivate = true ) {
3102
		?>
3103
<!doctype html>
3104
<html>
3105
<head>
3106
<meta charset="<?php bloginfo( 'charset' ); ?>">
3107
<style>
3108
* {
3109
	text-align: center;
3110
	margin: 0;
3111
	padding: 0;
3112
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3113
}
3114
p {
3115
	margin-top: 1em;
3116
	font-size: 18px;
3117
}
3118
</style>
3119
<body>
3120
<p><?php echo esc_html( $message ); ?></p>
3121
</body>
3122
</html>
3123
		<?php
3124
		if ( $deactivate ) {
3125
			$plugins = get_option( 'active_plugins' );
3126
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3127
			$update  = false;
3128
			foreach ( $plugins as $i => $plugin ) {
3129
				if ( $plugin === $jetpack ) {
3130
					$plugins[ $i ] = false;
3131
					$update        = true;
3132
				}
3133
			}
3134
3135
			if ( $update ) {
3136
				update_option( 'active_plugins', array_filter( $plugins ) );
3137
			}
3138
		}
3139
		exit;
3140
	}
3141
3142
	/**
3143
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3144
	 *
3145
	 * @static
3146
	 */
3147
	public static function plugin_activation( $network_wide ) {
3148
		Jetpack_Options::update_option( 'activated', 1 );
3149
3150
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3151
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3152
		}
3153
3154
		if ( $network_wide ) {
3155
			self::state( 'network_nag', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3156
		}
3157
3158
		// For firing one-off events (notices) immediately after activation
3159
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3160
3161
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3162
3163
		self::plugin_initialize();
3164
	}
3165
3166
	public static function get_activation_source( $referer_url ) {
3167
3168
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3169
			return array( 'wp-cli', null );
3170
		}
3171
3172
		$referer = wp_parse_url( $referer_url );
3173
3174
		$source_type  = 'unknown';
3175
		$source_query = null;
3176
3177
		if ( ! is_array( $referer ) ) {
3178
			return array( $source_type, $source_query );
3179
		}
3180
3181
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3182
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3183
3184
		if ( isset( $referer['query'] ) ) {
3185
			parse_str( $referer['query'], $query_parts );
3186
		} else {
3187
			$query_parts = array();
3188
		}
3189
3190
		if ( $plugins_path === $referer['path'] ) {
3191
			$source_type = 'list';
3192
		} elseif ( $plugins_install_path === $referer['path'] ) {
3193
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3194
			switch ( $tab ) {
3195
				case 'popular':
3196
					$source_type = 'popular';
3197
					break;
3198
				case 'recommended':
3199
					$source_type = 'recommended';
3200
					break;
3201
				case 'favorites':
3202
					$source_type = 'favorites';
3203
					break;
3204
				case 'search':
3205
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3206
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3207
					break;
3208
				default:
3209
					$source_type = 'featured';
3210
			}
3211
		}
3212
3213
		return array( $source_type, $source_query );
3214
	}
3215
3216
	/**
3217
	 * Runs before bumping version numbers up to a new version
3218
	 *
3219
	 * @param  string $version    Version:timestamp
3220
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3221
	 * @return null              [description]
3222
	 */
3223
	public static function do_version_bump( $version, $old_version ) {
3224
		if ( ! $old_version ) { // For new sites
3225
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3226
		}
3227
	}
3228
3229
	/**
3230
	 * Sets the internal version number and activation state.
3231
	 *
3232
	 * @static
3233
	 */
3234
	public static function plugin_initialize() {
3235
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3236
			Jetpack_Options::update_option( 'activated', 2 );
3237
		}
3238
3239 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3240
			$version = $old_version = JETPACK__VERSION . ':' . time();
3241
			/** This action is documented in class.jetpack.php */
3242
			do_action( 'updating_jetpack_version', $version, false );
3243
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3244
		}
3245
3246
		self::load_modules();
3247
3248
		Jetpack_Options::delete_option( 'do_activate' );
3249
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3250
	}
3251
3252
	/**
3253
	 * Removes all connection options
3254
	 *
3255
	 * @static
3256
	 */
3257
	public static function plugin_deactivation() {
3258
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3259
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3260
			Jetpack_Network::init()->deactivate();
3261
		} else {
3262
			self::disconnect( false );
3263
			// Jetpack_Heartbeat::init()->deactivate();
3264
		}
3265
	}
3266
3267
	/**
3268
	 * Disconnects from the Jetpack servers.
3269
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3270
	 *
3271
	 * @static
3272
	 */
3273
	public static function disconnect( $update_activated_state = true ) {
3274
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3275
		$connection = self::connection();
3276
		$connection->clean_nonces( true );
3277
3278
		// If the site is in an IDC because sync is not allowed,
3279
		// let's make sure to not disconnect the production site.
3280
		if ( ! self::validate_sync_error_idc_option() ) {
3281
			$tracking = new Tracking();
3282
			$tracking->record_user_event( 'disconnect_site', array() );
3283
3284
			$connection->disconnect_site_wpcom();
3285
		}
3286
3287
		$connection->delete_all_connection_tokens();
3288
		Jetpack_IDC::clear_all_idc_options();
3289
3290
		if ( $update_activated_state ) {
3291
			Jetpack_Options::update_option( 'activated', 4 );
3292
		}
3293
3294
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3295
			// Check then record unique disconnection if site has never been disconnected previously
3296
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3297
				$jetpack_unique_connection['disconnected'] = 1;
3298
			} else {
3299
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3300
					// track unique disconnect
3301
					$jetpack = self::init();
3302
3303
					$jetpack->stat( 'connections', 'unique-disconnect' );
3304
					$jetpack->do_stats( 'server_side' );
3305
				}
3306
				// increment number of times disconnected
3307
				$jetpack_unique_connection['disconnected'] += 1;
3308
			}
3309
3310
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3311
		}
3312
3313
		// Delete all the sync related data. Since it could be taking up space.
3314
		Sender::get_instance()->uninstall();
3315
3316
		// Disable the Heartbeat cron
3317
		Jetpack_Heartbeat::init()->deactivate();
3318
	}
3319
3320
	/**
3321
	 * Unlinks the current user from the linked WordPress.com user.
3322
	 *
3323
	 * @deprecated since 7.7
3324
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3325
	 *
3326
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|null?

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

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

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

Loading history...
3327
	 * @return Boolean Whether the disconnection of the user was successful.
3328
	 */
3329
	public static function unlink_user( $user_id = null ) {
3330
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3331
		return Connection_Manager::disconnect_user( $user_id );
3332
	}
3333
3334
	/**
3335
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3336
	 */
3337
	public static function try_registration() {
3338
		$terms_of_service = new Terms_Of_Service();
3339
		// The user has agreed to the TOS at some point by now.
3340
		$terms_of_service->agree();
3341
3342
		// Let's get some testing in beta versions and such.
3343
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3344
			// Before attempting to connect, let's make sure that the domains are viable.
3345
			$domains_to_check = array_unique(
3346
				array(
3347
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3348
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3349
				)
3350
			);
3351
			foreach ( $domains_to_check as $domain ) {
3352
				$result = self::connection()->is_usable_domain( $domain );
3353
				if ( is_wp_error( $result ) ) {
3354
					return $result;
3355
				}
3356
			}
3357
		}
3358
3359
		$result = self::register();
3360
3361
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3362
		if ( ! $result || is_wp_error( $result ) ) {
3363
			return $result;
3364
		} else {
3365
			return true;
3366
		}
3367
	}
3368
3369
	/**
3370
	 * Tracking an internal event log. Try not to put too much chaff in here.
3371
	 *
3372
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3373
	 */
3374
	public static function log( $code, $data = null ) {
3375
		// only grab the latest 200 entries
3376
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3377
3378
		// Append our event to the log
3379
		$log_entry = array(
3380
			'time'    => time(),
3381
			'user_id' => get_current_user_id(),
3382
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3383
			'code'    => $code,
3384
		);
3385
		// Don't bother storing it unless we've got some.
3386
		if ( ! is_null( $data ) ) {
3387
			$log_entry['data'] = $data;
3388
		}
3389
		$log[] = $log_entry;
3390
3391
		// Try add_option first, to make sure it's not autoloaded.
3392
		// @todo: Add an add_option method to Jetpack_Options
3393
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3394
			Jetpack_Options::update_option( 'log', $log );
3395
		}
3396
3397
		/**
3398
		 * Fires when Jetpack logs an internal event.
3399
		 *
3400
		 * @since 3.0.0
3401
		 *
3402
		 * @param array $log_entry {
3403
		 *  Array of details about the log entry.
3404
		 *
3405
		 *  @param string time Time of the event.
3406
		 *  @param int user_id ID of the user who trigerred the event.
3407
		 *  @param int blog_id Jetpack Blog ID.
3408
		 *  @param string code Unique name for the event.
3409
		 *  @param string data Data about the event.
3410
		 * }
3411
		 */
3412
		do_action( 'jetpack_log_entry', $log_entry );
3413
	}
3414
3415
	/**
3416
	 * Get the internal event log.
3417
	 *
3418
	 * @param $event (string) - only return the specific log events
3419
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3420
	 *
3421
	 * @return array of log events || WP_Error for invalid params
3422
	 */
3423
	public static function get_log( $event = false, $num = false ) {
3424
		if ( $event && ! is_string( $event ) ) {
3425
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with __('First param must be ...g or empty', 'jetpack').

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3426
		}
3427
3428
		if ( $num && ! is_numeric( $num ) ) {
3429
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with __('Second param must be...c or empty', 'jetpack').

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3430
		}
3431
3432
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3433
3434
		// If nothing set - act as it did before, otherwise let's start customizing the output
3435
		if ( ! $num && ! $event ) {
3436
			return $entire_log;
3437
		} else {
3438
			$entire_log = array_reverse( $entire_log );
3439
		}
3440
3441
		$custom_log_output = array();
3442
3443
		if ( $event ) {
3444
			foreach ( $entire_log as $log_event ) {
3445
				if ( $event == $log_event['code'] ) {
3446
					$custom_log_output[] = $log_event;
3447
				}
3448
			}
3449
		} else {
3450
			$custom_log_output = $entire_log;
3451
		}
3452
3453
		if ( $num ) {
3454
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3455
		}
3456
3457
		return $custom_log_output;
3458
	}
3459
3460
	/**
3461
	 * Log modification of important settings.
3462
	 */
3463
	public static function log_settings_change( $option, $old_value, $value ) {
3464
		switch ( $option ) {
3465
			case 'jetpack_sync_non_public_post_stati':
3466
				self::log( $option, $value );
3467
				break;
3468
		}
3469
	}
3470
3471
	/**
3472
	 * Return stat data for WPCOM sync
3473
	 */
3474
	public static function get_stat_data( $encode = true, $extended = true ) {
3475
		$data = Jetpack_Heartbeat::generate_stats_array();
3476
3477
		if ( $extended ) {
3478
			$additional_data = self::get_additional_stat_data();
3479
			$data            = array_merge( $data, $additional_data );
3480
		}
3481
3482
		if ( $encode ) {
3483
			return json_encode( $data );
3484
		}
3485
3486
		return $data;
3487
	}
3488
3489
	/**
3490
	 * Get additional stat data to sync to WPCOM
3491
	 */
3492
	public static function get_additional_stat_data( $prefix = '' ) {
3493
		$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...
3494
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3495
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3496
		$return[ "{$prefix}site-count" ]    = 0;
3497
3498
		if ( function_exists( 'get_blog_count' ) ) {
3499
			$return[ "{$prefix}site-count" ] = get_blog_count();
3500
		}
3501
		return $return;
3502
	}
3503
3504
	private static function get_site_user_count() {
3505
		global $wpdb;
3506
3507
		if ( function_exists( 'wp_is_large_network' ) ) {
3508
			if ( wp_is_large_network( 'users' ) ) {
3509
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3510
			}
3511
		}
3512
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3513
			// It wasn't there, so regenerate the data and save the transient
3514
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3515
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3516
		}
3517
		return $user_count;
3518
	}
3519
3520
	/* Admin Pages */
3521
3522
	function admin_init() {
3523
		// If the plugin is not connected, display a connect message.
3524
		if (
3525
			// the plugin was auto-activated and needs its candy
3526
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3527
		||
3528
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3529
			! Jetpack_Options::get_option( 'activated' )
3530
		) {
3531
			self::plugin_initialize();
3532
		}
3533
3534
		$is_development_mode = ( new Status() )->is_development_mode();
3535
		if ( ! self::is_active() && ! $is_development_mode ) {
3536
			Jetpack_Connection_Banner::init();
3537
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3538
			// Upgrade: 1.1 -> 1.1.1
3539
			// Check and see if host can verify the Jetpack servers' SSL certificate
3540
			$args       = array();
3541
			$connection = self::connection();
3542
			Client::_wp_remote_request(
3543
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3544
				$args,
3545
				true
3546
			);
3547
		}
3548
3549
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3550
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3551
		}
3552
3553
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3554
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3555
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3556
3557
		if ( self::is_active() || $is_development_mode ) {
3558
			// Artificially throw errors in certain whitelisted cases during plugin activation
3559
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3560
		}
3561
3562
		// Add custom column in wp-admin/users.php to show whether user is linked.
3563
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3564
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3565
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3566
	}
3567
3568
	function admin_body_class( $admin_body_class = '' ) {
3569
		$classes = explode( ' ', trim( $admin_body_class ) );
3570
3571
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3572
3573
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3574
		return " $admin_body_class ";
3575
	}
3576
3577
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3578
		return $admin_body_class . ' jetpack-pagestyles ';
3579
	}
3580
3581
	/**
3582
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3583
	 * This function artificially throws errors for such cases (whitelisted).
3584
	 *
3585
	 * @param string $plugin The activated plugin.
3586
	 */
3587
	function throw_error_on_activate_plugin( $plugin ) {
3588
		$active_modules = self::get_active_modules();
3589
3590
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3591
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3592
			$throw = false;
3593
3594
			// Try and make sure it really was the stats plugin
3595
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3596
				if ( 'stats.php' == basename( $plugin ) ) {
3597
					$throw = true;
3598
				}
3599
			} else {
3600
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3601
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3602
					$throw = true;
3603
				}
3604
			}
3605
3606
			if ( $throw ) {
3607
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3608
			}
3609
		}
3610
	}
3611
3612
	function intercept_plugin_error_scrape_init() {
3613
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3614
	}
3615
3616
	function intercept_plugin_error_scrape( $action, $result ) {
3617
		if ( ! $result ) {
3618
			return;
3619
		}
3620
3621
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3622
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3623
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3624
			}
3625
		}
3626
	}
3627
3628
	/**
3629
	 * Register the remote file upload request handlers, if needed.
3630
	 *
3631
	 * @access public
3632
	 */
3633
	public function add_remote_request_handlers() {
3634
		// Remote file uploads are allowed only via AJAX requests.
3635
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3636
			return;
3637
		}
3638
3639
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3640
		$remote_request_actions = array(
3641
			'jetpack_upload_file',
3642
			'jetpack_update_file',
3643
		);
3644
3645
		// phpcs:ignore WordPress.Security.NonceVerification
3646
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3647
			return;
3648
		}
3649
3650
		// Require Jetpack authentication for the remote file upload AJAX requests.
3651
		$this->connection_manager->require_jetpack_authentication();
3652
3653
		// Register the remote file upload AJAX handlers.
3654
		foreach ( $remote_request_actions as $action ) {
3655
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3656
		}
3657
	}
3658
3659
	/**
3660
	 * Handler for Jetpack remote file uploads.
3661
	 *
3662
	 * @access public
3663
	 */
3664
	public function remote_request_handlers() {
3665
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3666
3667
		switch ( current_filter() ) {
3668
			case 'wp_ajax_nopriv_jetpack_upload_file':
3669
				$response = $this->upload_handler();
3670
				break;
3671
3672
			case 'wp_ajax_nopriv_jetpack_update_file':
3673
				$response = $this->upload_handler( true );
3674
				break;
3675
			default:
3676
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_handler'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3677
				break;
3678
		}
3679
3680
		if ( ! $response ) {
3681
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_error'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3682
		}
3683
3684
		if ( is_wp_error( $response ) ) {
3685
			$status_code       = $response->get_error_data();
0 ignored issues
show
Bug introduced by
The method get_error_data() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3686
			$error             = $response->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3687
			$error_description = $response->get_error_message();
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3688
3689
			if ( ! is_int( $status_code ) ) {
3690
				$status_code = 400;
3691
			}
3692
3693
			status_header( $status_code );
3694
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3695
		}
3696
3697
		status_header( 200 );
3698
		if ( true === $response ) {
3699
			exit;
3700
		}
3701
3702
		die( json_encode( (object) $response ) );
3703
	}
3704
3705
	/**
3706
	 * Uploads a file gotten from the global $_FILES.
3707
	 * If `$update_media_item` is true and `post_id` is defined
3708
	 * the attachment file of the media item (gotten through of the post_id)
3709
	 * will be updated instead of add a new one.
3710
	 *
3711
	 * @param  boolean $update_media_item - update media attachment
3712
	 * @return array - An array describing the uploadind files process
3713
	 */
3714
	function upload_handler( $update_media_item = false ) {
3715
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3716
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 405.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3717
		}
3718
3719
		$user = wp_authenticate( '', '' );
3720
		if ( ! $user || is_wp_error( $user ) ) {
3721
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 403.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3722
		}
3723
3724
		wp_set_current_user( $user->ID );
3725
3726
		if ( ! current_user_can( 'upload_files' ) ) {
3727
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'cannot_upload_files'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3728
		}
3729
3730
		if ( empty( $_FILES ) ) {
3731
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'no_files_uploaded'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3732
		}
3733
3734
		foreach ( array_keys( $_FILES ) as $files_key ) {
3735
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3736
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'missing_hmac'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3737
			}
3738
		}
3739
3740
		$media_keys = array_keys( $_FILES['media'] );
3741
3742
		$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...
3743
		if ( ! $token || is_wp_error( $token ) ) {
3744
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_token'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3745
		}
3746
3747
		$uploaded_files = array();
3748
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3749
		unset( $GLOBALS['post'] );
3750
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3751
			$file = array();
3752
			foreach ( $media_keys as $media_key ) {
3753
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3754
			}
3755
3756
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3757
3758
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3759
			if ( $hmac_provided !== $hmac_file ) {
3760
				$uploaded_files[ $index ] = (object) array(
3761
					'error'             => 'invalid_hmac',
3762
					'error_description' => 'The corresponding HMAC for this file does not match',
3763
				);
3764
				continue;
3765
			}
3766
3767
			$_FILES['.jetpack.upload.'] = $file;
3768
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3769
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3770
				$post_id = 0;
3771
			}
3772
3773
			if ( $update_media_item ) {
3774
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3775
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'invalid_input'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3776
				}
3777
3778
				$media_array = $_FILES['media'];
3779
3780
				$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...
3781
				$file_array['type']     = $media_array['type'][0];
3782
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3783
				$file_array['error']    = $media_array['error'][0];
3784
				$file_array['size']     = $media_array['size'][0];
3785
3786
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3787
3788
				if ( is_wp_error( $edited_media_item ) ) {
3789
					return $edited_media_item;
3790
				}
3791
3792
				$response = (object) array(
3793
					'id'   => (string) $post_id,
3794
					'file' => (string) $edited_media_item->post_title,
3795
					'url'  => (string) wp_get_attachment_url( $post_id ),
3796
					'type' => (string) $edited_media_item->post_mime_type,
3797
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3798
				);
3799
3800
				return (array) array( $response );
3801
			}
3802
3803
			$attachment_id = media_handle_upload(
3804
				'.jetpack.upload.',
3805
				$post_id,
3806
				array(),
3807
				array(
3808
					'action' => 'jetpack_upload_file',
3809
				)
3810
			);
3811
3812
			if ( ! $attachment_id ) {
3813
				$uploaded_files[ $index ] = (object) array(
3814
					'error'             => 'unknown',
3815
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3816
				);
3817
			} elseif ( is_wp_error( $attachment_id ) ) {
3818
				$uploaded_files[ $index ] = (object) array(
3819
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3820
					'error_description' => $attachment_id->get_error_message(),
3821
				);
3822
			} else {
3823
				$attachment               = get_post( $attachment_id );
3824
				$uploaded_files[ $index ] = (object) array(
3825
					'id'   => (string) $attachment_id,
3826
					'file' => $attachment->post_title,
3827
					'url'  => wp_get_attachment_url( $attachment_id ),
3828
					'type' => $attachment->post_mime_type,
3829
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3830
				);
3831
				// Zip files uploads are not supported unless they are done for installation purposed
3832
				// lets delete them in case something goes wrong in this whole process
3833
				if ( 'application/zip' === $attachment->post_mime_type ) {
3834
					// Schedule a cleanup for 2 hours from now in case of failed install.
3835
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3836
				}
3837
			}
3838
		}
3839
		if ( ! is_null( $global_post ) ) {
3840
			$GLOBALS['post'] = $global_post;
3841
		}
3842
3843
		return $uploaded_files;
3844
	}
3845
3846
	/**
3847
	 * Add help to the Jetpack page
3848
	 *
3849
	 * @since Jetpack (1.2.3)
3850
	 * @return false if not the Jetpack page
3851
	 */
3852
	function admin_help() {
3853
		$current_screen = get_current_screen();
3854
3855
		// Overview
3856
		$current_screen->add_help_tab(
3857
			array(
3858
				'id'      => 'home',
3859
				'title'   => __( 'Home', 'jetpack' ),
3860
				'content' =>
3861
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3862
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3863
					'<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>',
3864
			)
3865
		);
3866
3867
		// Screen Content
3868
		if ( current_user_can( 'manage_options' ) ) {
3869
			$current_screen->add_help_tab(
3870
				array(
3871
					'id'      => 'settings',
3872
					'title'   => __( 'Settings', 'jetpack' ),
3873
					'content' =>
3874
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3875
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3876
						'<ol>' .
3877
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3878
							'<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>' .
3879
						'</ol>' .
3880
						'<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>',
3881
				)
3882
			);
3883
		}
3884
3885
		// Help Sidebar
3886
		$current_screen->set_help_sidebar(
3887
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3888
			'<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3889
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3890
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3891
		);
3892
	}
3893
3894
	function admin_menu_css() {
3895
		wp_enqueue_style( 'jetpack-icons' );
3896
	}
3897
3898
	function admin_menu_order() {
3899
		return true;
3900
	}
3901
3902 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3903
		$jp_menu_order = array();
3904
3905
		foreach ( $menu_order as $index => $item ) {
3906
			if ( $item != 'jetpack' ) {
3907
				$jp_menu_order[] = $item;
3908
			}
3909
3910
			if ( $index == 0 ) {
3911
				$jp_menu_order[] = 'jetpack';
3912
			}
3913
		}
3914
3915
		return $jp_menu_order;
3916
	}
3917
3918
	function admin_banner_styles() {
3919
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3920
3921 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3922
			wp_register_style(
3923
				'jetpack-dops-style',
3924
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3925
				array(),
3926
				JETPACK__VERSION
3927
			);
3928
		}
3929
3930
		wp_enqueue_style(
3931
			'jetpack',
3932
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3933
			array( 'jetpack-dops-style' ),
3934
			JETPACK__VERSION . '-20121016'
3935
		);
3936
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3937
		wp_style_add_data( 'jetpack', 'suffix', $min );
3938
	}
3939
3940
	function plugin_action_links( $actions ) {
3941
3942
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3943
3944
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
3945
			return array_merge(
3946
				$jetpack_home,
3947
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3948
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3949
				$actions
3950
			);
3951
		}
3952
3953
		return array_merge( $jetpack_home, $actions );
3954
	}
3955
3956
	/*
3957
	 * Registration flow:
3958
	 * 1 - ::admin_page_load() action=register
3959
	 * 2 - ::try_registration()
3960
	 * 3 - ::register()
3961
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3962
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3963
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3964
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3965
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3966
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3967
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3968
	 *       jetpack_id, jetpack_secret, jetpack_public
3969
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3970
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3971
	 * 5 - user logs in with WP.com account
3972
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3973
	 *		- Manager::authorize()
3974
	 *		- Manager::get_token()
3975
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3976
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3977
	 *			- which responds with access_token, token_type, scope
3978
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
3979
	 *		- Jetpack::activate_default_modules()
3980
	 *     		- Deactivates deprecated plugins
3981
	 *     		- Activates all default modules
3982
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3983
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3984
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3985
	 *     Done!
3986
	 */
3987
3988
	/**
3989
	 * Handles the page load events for the Jetpack admin page
3990
	 */
3991
	function admin_page_load() {
3992
		$error = false;
3993
3994
		// Make sure we have the right body class to hook stylings for subpages off of.
3995
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
3996
3997
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3998
			// Should only be used in intermediate redirects to preserve state across redirects
3999
			self::restate();
4000
		}
4001
4002
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4003
			// @todo: Add validation against a known whitelist
4004
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4005
			// User clicked in the iframe to link their accounts
4006
			if ( ! self::is_user_connected() ) {
4007
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4008
4009
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4010
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4011
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4012
4013
				if ( isset( $_GET['notes_iframe'] ) ) {
4014
					$connect_url .= '&notes_iframe';
4015
				}
4016
				wp_redirect( $connect_url );
4017
				exit;
4018
			} else {
4019
				if ( ! isset( $_GET['calypso_env'] ) ) {
4020
					self::state( 'message', 'already_authorized' );
4021
					wp_safe_redirect( self::admin_url() );
4022
					exit;
4023
				} else {
4024
					$connect_url  = $this->build_connect_url( true, false, $from );
4025
					$connect_url .= '&already_authorized=true';
4026
					wp_redirect( $connect_url );
4027
					exit;
4028
				}
4029
			}
4030
		}
4031
4032
		if ( isset( $_GET['action'] ) ) {
4033
			switch ( $_GET['action'] ) {
4034
				case 'authorize':
4035
					if ( self::is_active() && self::is_user_connected() ) {
4036
						self::state( 'message', 'already_authorized' );
4037
						wp_safe_redirect( self::admin_url() );
4038
						exit;
4039
					}
4040
					self::log( 'authorize' );
4041
					$client_server = new Jetpack_Client_Server();
4042
					$client_server->client_authorize();
4043
					exit;
4044
				case 'register':
4045
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4046
						$error = 'cheatin';
4047
						break;
4048
					}
4049
					check_admin_referer( 'jetpack-register' );
4050
					self::log( 'register' );
4051
					self::maybe_set_version_option();
4052
					$registered = self::try_registration();
4053
					if ( is_wp_error( $registered ) ) {
4054
						$error = $registered->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4055
						self::state( 'error', $error );
4056
						self::state( 'error', $registered->get_error_message() );
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4057
4058
						/**
4059
						 * Jetpack registration Error.
4060
						 *
4061
						 * @since 7.5.0
4062
						 *
4063
						 * @param string|int $error The error code.
4064
						 * @param \WP_Error $registered The error object.
4065
						 */
4066
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4067
						break;
4068
					}
4069
4070
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4071
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4072
4073
					/**
4074
					 * Jetpack registration Success.
4075
					 *
4076
					 * @since 7.5.0
4077
					 *
4078
					 * @param string $from 'from' GET parameter;
4079
					 */
4080
					do_action( 'jetpack_connection_register_success', $from );
4081
4082
					$url = $this->build_connect_url( true, $redirect, $from );
4083
4084
					if ( ! empty( $_GET['onboarding'] ) ) {
4085
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4086
					}
4087
4088
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4089
						$url = add_query_arg( 'auth_approved', 'true', $url );
4090
					}
4091
4092
					wp_redirect( $url );
4093
					exit;
4094
				case 'activate':
4095
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4096
						$error = 'cheatin';
4097
						break;
4098
					}
4099
4100
					$module = stripslashes( $_GET['module'] );
4101
					check_admin_referer( "jetpack_activate-$module" );
4102
					self::log( 'activate', $module );
4103
					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...
4104
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4105
					}
4106
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4107
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4108
					exit;
4109
				case 'activate_default_modules':
4110
					check_admin_referer( 'activate_default_modules' );
4111
					self::log( 'activate_default_modules' );
4112
					self::restate();
4113
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4114
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4115
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4116
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4117
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4118
					exit;
4119
				case 'disconnect':
4120
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4121
						$error = 'cheatin';
4122
						break;
4123
					}
4124
4125
					check_admin_referer( 'jetpack-disconnect' );
4126
					self::log( 'disconnect' );
4127
					self::disconnect();
4128
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4129
					exit;
4130
				case 'reconnect':
4131
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4132
						$error = 'cheatin';
4133
						break;
4134
					}
4135
4136
					check_admin_referer( 'jetpack-reconnect' );
4137
					self::log( 'reconnect' );
4138
					$this->disconnect();
4139
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4140
					exit;
4141 View Code Duplication
				case 'deactivate':
4142
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4143
						$error = 'cheatin';
4144
						break;
4145
					}
4146
4147
					$modules = stripslashes( $_GET['module'] );
4148
					check_admin_referer( "jetpack_deactivate-$modules" );
4149
					foreach ( explode( ',', $modules ) as $module ) {
4150
						self::log( 'deactivate', $module );
4151
						self::deactivate_module( $module );
4152
						self::state( 'message', 'module_deactivated' );
4153
					}
4154
					self::state( 'module', $modules );
4155
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4156
					exit;
4157
				case 'unlink':
4158
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4159
					check_admin_referer( 'jetpack-unlink' );
4160
					self::log( 'unlink' );
4161
					Connection_Manager::disconnect_user();
4162
					self::state( 'message', 'unlinked' );
4163
					if ( 'sub-unlink' == $redirect ) {
4164
						wp_safe_redirect( admin_url() );
4165
					} else {
4166
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4167
					}
4168
					exit;
4169
				case 'onboard':
4170
					if ( ! current_user_can( 'manage_options' ) ) {
4171
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4172
					} else {
4173
						self::create_onboarding_token();
4174
						$url = $this->build_connect_url( true );
4175
4176
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4177
							$url = add_query_arg( 'onboarding', $token, $url );
4178
						}
4179
4180
						$calypso_env = $this->get_calypso_env();
4181
						if ( ! empty( $calypso_env ) ) {
4182
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4183
						}
4184
4185
						wp_redirect( $url );
4186
						exit;
4187
					}
4188
					exit;
4189
				default:
4190
					/**
4191
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4192
					 *
4193
					 * @since 2.6.0
4194
					 *
4195
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4196
					 */
4197
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4198
			}
4199
		}
4200
4201
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4202
			self::activate_new_modules( true );
4203
		}
4204
4205
		$message_code = self::state( 'message' );
4206
		if ( self::state( 'optin-manage' ) ) {
4207
			$activated_manage = $message_code;
4208
			$message_code     = 'jetpack-manage';
4209
		}
4210
4211
		switch ( $message_code ) {
4212
			case 'jetpack-manage':
4213
				$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>';
4214
				if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4215
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4216
				}
4217
				break;
4218
4219
		}
4220
4221
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4222
4223
		if ( ! empty( $deactivated_plugins ) ) {
4224
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4225
			$deactivated_titles  = array();
4226
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4227
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4228
					continue;
4229
				}
4230
4231
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4232
			}
4233
4234
			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...
4235
				if ( $this->message ) {
4236
					$this->message .= "<br /><br />\n";
4237
				}
4238
4239
				$this->message .= wp_sprintf(
4240
					_n(
4241
						'Jetpack contains the most recent version of the old %l plugin.',
4242
						'Jetpack contains the most recent versions of the old %l plugins.',
4243
						count( $deactivated_titles ),
4244
						'jetpack'
4245
					),
4246
					$deactivated_titles
4247
				);
4248
4249
				$this->message .= "<br />\n";
4250
4251
				$this->message .= _n(
4252
					'The old version has been deactivated and can be removed from your site.',
4253
					'The old versions have been deactivated and can be removed from your site.',
4254
					count( $deactivated_titles ),
4255
					'jetpack'
4256
				);
4257
			}
4258
		}
4259
4260
		$this->privacy_checks = self::state( 'privacy_checks' );
4261
4262
		if ( $this->message || $this->error || $this->privacy_checks ) {
4263
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4264
		}
4265
4266
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4267
	}
4268
4269
	function admin_notices() {
4270
4271
		if ( $this->error ) {
4272
			?>
4273
<div id="message" class="jetpack-message jetpack-err">
4274
	<div class="squeezer">
4275
		<h2>
4276
			<?php
4277
			echo wp_kses(
4278
				$this->error,
4279
				array(
4280
					'a'      => array( 'href' => array() ),
4281
					'small'  => true,
4282
					'code'   => true,
4283
					'strong' => true,
4284
					'br'     => true,
4285
					'b'      => true,
4286
				)
4287
			);
4288
			?>
4289
			</h2>
4290
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4291
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4292
<?php	endif; ?>
4293
	</div>
4294
</div>
4295
			<?php
4296
		}
4297
4298
		if ( $this->message ) {
4299
			?>
4300
<div id="message" class="jetpack-message">
4301
	<div class="squeezer">
4302
		<h2>
4303
			<?php
4304
			echo wp_kses(
4305
				$this->message,
4306
				array(
4307
					'strong' => array(),
4308
					'a'      => array( 'href' => true ),
4309
					'br'     => true,
4310
				)
4311
			);
4312
			?>
4313
			</h2>
4314
	</div>
4315
</div>
4316
			<?php
4317
		}
4318
4319
		if ( $this->privacy_checks ) :
4320
			$module_names = $module_slugs = array();
4321
4322
			$privacy_checks = explode( ',', $this->privacy_checks );
4323
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4324
			foreach ( $privacy_checks as $module_slug ) {
4325
				$module = self::get_module( $module_slug );
4326
				if ( ! $module ) {
4327
					continue;
4328
				}
4329
4330
				$module_slugs[] = $module_slug;
4331
				$module_names[] = "<strong>{$module['name']}</strong>";
4332
			}
4333
4334
			$module_slugs = join( ',', $module_slugs );
4335
			?>
4336
<div id="message" class="jetpack-message jetpack-err">
4337
	<div class="squeezer">
4338
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4339
		<p>
4340
			<?php
4341
			echo wp_kses(
4342
				wptexturize(
4343
					wp_sprintf(
4344
						_nx(
4345
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4346
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4347
							count( $privacy_checks ),
4348
							'%l = list of Jetpack module/feature names',
4349
							'jetpack'
4350
						),
4351
						$module_names
4352
					)
4353
				),
4354
				array( 'strong' => true )
4355
			);
4356
4357
			echo "\n<br />\n";
4358
4359
			echo wp_kses(
4360
				sprintf(
4361
					_nx(
4362
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4363
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4364
						count( $privacy_checks ),
4365
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4366
						'jetpack'
4367
					),
4368
					wp_nonce_url(
4369
						self::admin_url(
4370
							array(
4371
								'page'   => 'jetpack',
4372
								'action' => 'deactivate',
4373
								'module' => urlencode( $module_slugs ),
4374
							)
4375
						),
4376
						"jetpack_deactivate-$module_slugs"
4377
					),
4378
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4379
				),
4380
				array(
4381
					'a' => array(
4382
						'href'  => true,
4383
						'title' => true,
4384
					),
4385
				)
4386
			);
4387
			?>
4388
		</p>
4389
	</div>
4390
</div>
4391
			<?php
4392
endif;
4393
	}
4394
4395
	/**
4396
	 * We can't always respond to a signed XML-RPC request with a
4397
	 * helpful error message. In some circumstances, doing so could
4398
	 * leak information.
4399
	 *
4400
	 * Instead, track that the error occurred via a Jetpack_Option,
4401
	 * and send that data back in the heartbeat.
4402
	 * All this does is increment a number, but it's enough to find
4403
	 * trends.
4404
	 *
4405
	 * @param WP_Error $xmlrpc_error The error produced during
4406
	 *                               signature validation.
4407
	 */
4408
	function track_xmlrpc_error( $xmlrpc_error ) {
4409
		$code = is_wp_error( $xmlrpc_error )
4410
			? $xmlrpc_error->get_error_code()
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4411
			: 'should-not-happen';
4412
4413
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4414
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4415
			// No need to update the option if we already have
4416
			// this code stored.
4417
			return;
4418
		}
4419
		$xmlrpc_errors[ $code ] = true;
4420
4421
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4422
	}
4423
4424
	/**
4425
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4426
	 */
4427
	function stat( $group, $detail ) {
4428
		if ( ! isset( $this->stats[ $group ] ) ) {
4429
			$this->stats[ $group ] = array();
4430
		}
4431
		$this->stats[ $group ][] = $detail;
4432
	}
4433
4434
	/**
4435
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4436
	 */
4437
	function do_stats( $method = '' ) {
4438
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4439
			foreach ( $this->stats as $group => $stats ) {
4440
				if ( is_array( $stats ) && count( $stats ) ) {
4441
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4442
					if ( 'server_side' === $method ) {
4443
						self::do_server_side_stat( $args );
4444
					} else {
4445
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4446
					}
4447
				}
4448
				unset( $this->stats[ $group ] );
4449
			}
4450
		}
4451
	}
4452
4453
	/**
4454
	 * Runs stats code for a one-off, server-side.
4455
	 *
4456
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4457
	 *
4458
	 * @return bool If it worked.
4459
	 */
4460
	static function do_server_side_stat( $args ) {
4461
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4462
		if ( is_wp_error( $response ) ) {
4463
			return false;
4464
		}
4465
4466
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4467
			return false;
4468
		}
4469
4470
		return true;
4471
	}
4472
4473
	/**
4474
	 * Builds the stats url.
4475
	 *
4476
	 * @param $args array|string The arguments to append to the URL.
4477
	 *
4478
	 * @return string The URL to be pinged.
4479
	 */
4480
	static function build_stats_url( $args ) {
4481
		$defaults = array(
4482
			'v'    => 'wpcom2',
4483
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4484
		);
4485
		$args     = wp_parse_args( $args, $defaults );
4486
		/**
4487
		 * Filter the URL used as the Stats tracking pixel.
4488
		 *
4489
		 * @since 2.3.2
4490
		 *
4491
		 * @param string $url Base URL used as the Stats tracking pixel.
4492
		 */
4493
		$base_url = apply_filters(
4494
			'jetpack_stats_base_url',
4495
			'https://pixel.wp.com/g.gif'
4496
		);
4497
		$url      = add_query_arg( $args, $base_url );
4498
		return $url;
4499
	}
4500
4501
	/**
4502
	 * Get the role of the current user.
4503
	 *
4504
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4505
	 *
4506
	 * @access public
4507
	 * @static
4508
	 *
4509
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4510
	 */
4511
	public static function translate_current_user_to_role() {
4512
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4513
4514
		$roles = new Roles();
4515
		return $roles->translate_current_user_to_role();
4516
	}
4517
4518
	/**
4519
	 * Get the role of a particular user.
4520
	 *
4521
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4522
	 *
4523
	 * @access public
4524
	 * @static
4525
	 *
4526
	 * @param \WP_User $user User object.
4527
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4528
	 */
4529
	public static function translate_user_to_role( $user ) {
4530
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4531
4532
		$roles = new Roles();
4533
		return $roles->translate_user_to_role( $user );
4534
	}
4535
4536
	/**
4537
	 * Get the minimum capability for a role.
4538
	 *
4539
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4540
	 *
4541
	 * @access public
4542
	 * @static
4543
	 *
4544
	 * @param string $role Role name.
4545
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4546
	 */
4547
	public static function translate_role_to_cap( $role ) {
4548
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4549
4550
		$roles = new Roles();
4551
		return $roles->translate_role_to_cap( $role );
4552
	}
4553
4554
	/**
4555
	 * Sign a user role with the master access token.
4556
	 * If not specified, will default to the current user.
4557
	 *
4558
	 * @deprecated since 7.7
4559
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4560
	 *
4561
	 * @access public
4562
	 * @static
4563
	 *
4564
	 * @param string $role    User role.
4565
	 * @param int    $user_id ID of the user.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|null?

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

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

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

Loading history...
4566
	 * @return string Signed user role.
4567
	 */
4568
	public static function sign_role( $role, $user_id = null ) {
4569
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4570
		return self::connection()->sign_role( $role, $user_id );
4571
	}
4572
4573
	/**
4574
	 * Builds a URL to the Jetpack connection auth page
4575
	 *
4576
	 * @since 3.9.5
4577
	 *
4578
	 * @param bool        $raw If true, URL will not be escaped.
4579
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4580
	 *                              If string, will be a custom redirect.
4581
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4582
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4583
	 *
4584
	 * @return string Connect URL
4585
	 */
4586
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4587
		$site_id    = Jetpack_Options::get_option( 'id' );
4588
		$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...
4589
4590
		if ( $register || ! $blog_token || ! $site_id ) {
4591
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4592
4593
			if ( ! empty( $redirect ) ) {
4594
				$url = add_query_arg(
4595
					'redirect',
4596
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4597
					$url
4598
				);
4599
			}
4600
4601
			if ( is_network_admin() ) {
4602
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4603
			}
4604
4605
			$calypso_env = self::get_calypso_env();
4606
4607
			if ( ! empty( $calypso_env ) ) {
4608
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4609
			}
4610
		} else {
4611
4612
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4613
			// because otherwise this logic can get us in to a loop.
4614
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4615
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4616
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4617
4618
				$response = Client::wpcom_json_api_request_as_blog(
4619
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4620
					'1.1'
4621
				);
4622
4623
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4624
4625
					// Generating a register URL instead to refresh the existing token
4626
					return $this->build_connect_url( $raw, $redirect, $from, true );
4627
				}
4628
			}
4629
4630
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4586 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...
4631
		}
4632
4633
		if ( $from ) {
4634
			$url = add_query_arg( 'from', $from, $url );
4635
		}
4636
4637
		// Ensure that class to get the affiliate code is loaded
4638
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
4639
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
4640
		}
4641
		// Get affiliate code and add it to the URL
4642
		$url = Jetpack_Affiliate::init()->add_code_as_query_arg( $url );
4643
4644
		return $raw ? esc_url_raw( $url ) : esc_url( $url );
4645
	}
4646
4647
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4648
4649
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4650
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4651
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4652
4653
		if ( $iframe ) {
4654
			add_filter( 'jetpack_api_url', array( __CLASS__, 'filter_connect_api_iframe_url' ), 10, 2 );
4655
		}
4656
4657
		$c8n = self::connection();
4658
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
0 ignored issues
show
Documentation introduced by
$redirect is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

Loading history...
5152
	 * @param Integer $exp     Expiration time in seconds.
5153
	 * @return array
5154
	 */
5155
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5156
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5157
	}
5158
5159
	public static function get_secrets( $action, $user_id ) {
5160
		$secrets = self::connection()->get_secrets( $action, $user_id );
5161
5162
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5163
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_missing'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5164
		}
5165
5166
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5167
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_expired'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5168
		}
5169
5170
		return $secrets;
5171
	}
5172
5173
	/**
5174
	 * @deprecated 7.5 Use Connection_Manager instead.
5175
	 *
5176
	 * @param $action
5177
	 * @param $user_id
5178
	 */
5179
	public static function delete_secrets( $action, $user_id ) {
5180
		return self::connection()->delete_secrets( $action, $user_id );
5181
	}
5182
5183
	/**
5184
	 * Builds the timeout limit for queries talking with the wpcom servers.
5185
	 *
5186
	 * Based on local php max_execution_time in php.ini
5187
	 *
5188
	 * @since 2.6
5189
	 * @return int
5190
	 * @deprecated
5191
	 **/
5192
	public function get_remote_query_timeout_limit() {
5193
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5194
		return self::get_max_execution_time();
5195
	}
5196
5197
	/**
5198
	 * Builds the timeout limit for queries talking with the wpcom servers.
5199
	 *
5200
	 * Based on local php max_execution_time in php.ini
5201
	 *
5202
	 * @since 5.4
5203
	 * @return int
5204
	 **/
5205
	public static function get_max_execution_time() {
5206
		$timeout = (int) ini_get( 'max_execution_time' );
5207
5208
		// Ensure exec time set in php.ini
5209
		if ( ! $timeout ) {
5210
			$timeout = 30;
5211
		}
5212
		return $timeout;
5213
	}
5214
5215
	/**
5216
	 * Sets a minimum request timeout, and returns the current timeout
5217
	 *
5218
	 * @since 5.4
5219
	 **/
5220 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5221
		$timeout = self::get_max_execution_time();
5222
		if ( $timeout < $min_timeout ) {
5223
			$timeout = $min_timeout;
5224
			set_time_limit( $timeout );
5225
		}
5226
		return $timeout;
5227
	}
5228
5229
	/**
5230
	 * Takes the response from the Jetpack register new site endpoint and
5231
	 * verifies it worked properly.
5232
	 *
5233
	 * @since 2.6
5234
	 * @deprecated since 7.7.0
5235
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5236
	 **/
5237
	public function validate_remote_register_response() {
5238
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5239
	}
5240
5241
	/**
5242
	 * @return bool|WP_Error
5243
	 */
5244
	public static function register() {
5245
		$tracking = new Tracking();
5246
		$tracking->record_user_event( 'jpc_register_begin' );
5247
5248
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5249
5250
		$connection   = self::connection();
5251
		$registration = $connection->register();
5252
5253
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5254
5255
		if ( ! $registration || is_wp_error( $registration ) ) {
5256
			return $registration;
5257
		}
5258
5259
		return true;
5260
	}
5261
5262
	/**
5263
	 * Filters the registration request body to include tracking properties.
5264
	 *
5265
	 * @param Array $properties
5266
	 * @return Array amended properties.
5267
	 */
5268 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5269
		$tracking        = new Tracking();
5270
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5271
5272
		return array_merge(
5273
			$properties,
5274
			array(
5275
				'_ui' => $tracks_identity['_ui'],
5276
				'_ut' => $tracks_identity['_ut'],
5277
			)
5278
		);
5279
	}
5280
5281
	/**
5282
	 * Filters the token request body to include tracking properties.
5283
	 *
5284
	 * @param Array $properties
5285
	 * @return Array amended properties.
5286
	 */
5287 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5288
		$tracking        = new Tracking();
5289
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5290
5291
		return array_merge(
5292
			$properties,
5293
			array(
5294
				'_ui' => $tracks_identity['_ui'],
5295
				'_ut' => $tracks_identity['_ut'],
5296
			)
5297
		);
5298
	}
5299
5300
	/**
5301
	 * If the db version is showing something other that what we've got now, bump it to current.
5302
	 *
5303
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
Documentation introduced by
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

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

Loading history...
5304
	 */
5305
	public static function maybe_set_version_option() {
5306
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5307
		if ( JETPACK__VERSION != $version ) {
5308
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5309
5310
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5311
				/** This action is documented in class.jetpack.php */
5312
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5313
			}
5314
5315
			return true;
5316
		}
5317
		return false;
5318
	}
5319
5320
	/* Client Server API */
5321
5322
	/**
5323
	 * Loads the Jetpack XML-RPC client.
5324
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5325
	 *
5326
	 * @deprecated since 7.7.0
5327
	 */
5328
	public static function load_xml_rpc_client() {
5329
		// Removed the php notice that shows up in order to give time to Akismet and VaultPress time to update.
5330
		// _deprecated_function( __METHOD__, 'jetpack-7.7' );
5331
	}
5332
5333
	/**
5334
	 * Resets the saved authentication state in between testing requests.
5335
	 */
5336
	public function reset_saved_auth_state() {
5337
		$this->rest_authentication_status = null;
5338
		$this->connection_manager->reset_saved_auth_state();
5339
	}
5340
5341
	/**
5342
	 * Verifies the signature of the current request.
5343
	 *
5344
	 * @deprecated since 7.7.0
5345
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5346
	 *
5347
	 * @return false|array
5348
	 */
5349
	public function verify_xml_rpc_signature() {
5350
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5351
		return self::connection()->verify_xml_rpc_signature();
5352
	}
5353
5354
	/**
5355
	 * Verifies the signature of the current request.
5356
	 *
5357
	 * This function has side effects and should not be used. Instead,
5358
	 * use the memoized version `->verify_xml_rpc_signature()`.
5359
	 *
5360
	 * @deprecated since 7.7.0
5361
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5362
	 * @internal
5363
	 */
5364
	private function internal_verify_xml_rpc_signature() {
5365
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5366
	}
5367
5368
	/**
5369
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5370
	 *
5371
	 * @deprecated since 7.7.0
5372
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5373
	 *
5374
	 * @param \WP_User|mixed $user     User object if authenticated.
5375
	 * @param string         $username Username.
5376
	 * @param string         $password Password string.
5377
	 * @return \WP_User|mixed Authenticated user or error.
5378
	 */
5379
	public function authenticate_jetpack( $user, $username, $password ) {
5380
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5381
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5382
	}
5383
5384
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5385
	// Uses the existing XMLRPC request signing implementation.
5386
	function wp_rest_authenticate( $user ) {
5387
		if ( ! empty( $user ) ) {
5388
			// Another authentication method is in effect.
5389
			return $user;
5390
		}
5391
5392
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5393
			// Nothing to do for this authentication method.
5394
			return null;
5395
		}
5396
5397
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5398
			// Nothing to do for this authentication method.
5399
			return null;
5400
		}
5401
5402
		// Ensure that we always have the request body available.  At this
5403
		// point, the WP REST API code to determine the request body has not
5404
		// run yet.  That code may try to read from 'php://input' later, but
5405
		// this can only be done once per request in PHP versions prior to 5.6.
5406
		// So we will go ahead and perform this read now if needed, and save
5407
		// the request body where both the Jetpack signature verification code
5408
		// and the WP REST API code can see it.
5409
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5410
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5411
		}
5412
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5413
5414
		// Only support specific request parameters that have been tested and
5415
		// are known to work with signature verification.  A different method
5416
		// can be passed to the WP REST API via the '?_method=' parameter if
5417
		// needed.
5418
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5419
			$this->rest_authentication_status = new WP_Error(
5420
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5421
				__( 'This request method is not supported.', 'jetpack' ),
5422
				array( 'status' => 400 )
5423
			);
5424
			return null;
5425
		}
5426
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5427
			$this->rest_authentication_status = new WP_Error(
5428
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5429
				__( 'This request method does not support body parameters.', 'jetpack' ),
5430
				array( 'status' => 400 )
5431
			);
5432
			return null;
5433
		}
5434
5435
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5436
5437
		if (
5438
			$verified &&
5439
			isset( $verified['type'] ) &&
5440
			'user' === $verified['type'] &&
5441
			! empty( $verified['user_id'] )
5442
		) {
5443
			// Authentication successful.
5444
			$this->rest_authentication_status = true;
5445
			return $verified['user_id'];
5446
		}
5447
5448
		// Something else went wrong.  Probably a signature error.
5449
		$this->rest_authentication_status = new WP_Error(
5450
			'rest_invalid_signature',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_signature'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5451
			__( 'The request is not signed correctly.', 'jetpack' ),
5452
			array( 'status' => 400 )
5453
		);
5454
		return null;
5455
	}
5456
5457
	/**
5458
	 * Report authentication status to the WP REST API.
5459
	 *
5460
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
5461
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5462
	 */
5463
	public function wp_rest_authentication_errors( $value ) {
5464
		if ( $value !== null ) {
5465
			return $value;
5466
		}
5467
		return $this->rest_authentication_status;
5468
	}
5469
5470
	/**
5471
	 * Add our nonce to this request.
5472
	 *
5473
	 * @deprecated since 7.7.0
5474
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5475
	 *
5476
	 * @param int    $timestamp Timestamp of the request.
5477
	 * @param string $nonce     Nonce string.
5478
	 */
5479
	public function add_nonce( $timestamp, $nonce ) {
5480
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5481
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5482
	}
5483
5484
	/**
5485
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5486
	 * Capture it here so we can verify the signature later.
5487
	 *
5488
	 * @deprecated since 7.7.0
5489
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5490
	 *
5491
	 * @param array $methods XMLRPC methods.
5492
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5493
	 */
5494
	public function xmlrpc_methods( $methods ) {
5495
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5496
		return $this->connection_manager->xmlrpc_methods( $methods );
5497
	}
5498
5499
	/**
5500
	 * Register additional public XMLRPC methods.
5501
	 *
5502
	 * @deprecated since 7.7.0
5503
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5504
	 *
5505
	 * @param array $methods Public XMLRPC methods.
5506
	 * @return array Public XMLRPC methods, with the getOptions one.
5507
	 */
5508
	public function public_xmlrpc_methods( $methods ) {
5509
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5510
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5511
	}
5512
5513
	/**
5514
	 * Handles a getOptions XMLRPC method call.
5515
	 *
5516
	 * @deprecated since 7.7.0
5517
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5518
	 *
5519
	 * @param array $args method call arguments.
5520
	 * @return array an amended XMLRPC server options array.
5521
	 */
5522
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5523
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5524
		return $this->connection_manager->jetpack_getOptions( $args );
0 ignored issues
show
Bug introduced by
The method jetpack_getOptions() does not exist on Automattic\Jetpack\Connection\Manager. Did you maybe mean jetpack_get_options()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
5525
	}
5526
5527
	/**
5528
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5529
	 *
5530
	 * @deprecated since 7.7.0
5531
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5532
	 *
5533
	 * @param array $options Standard Core options.
5534
	 * @return array Amended options.
5535
	 */
5536
	public function xmlrpc_options( $options ) {
5537
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5538
		return $this->connection_manager->xmlrpc_options( $options );
5539
	}
5540
5541
	/**
5542
	 * Cleans nonces that were saved when calling ::add_nonce.
5543
	 *
5544
	 * @deprecated since 7.7.0
5545
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5546
	 *
5547
	 * @param bool $all whether to clean even non-expired nonces.
5548
	 */
5549
	public static function clean_nonces( $all = false ) {
5550
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5551
		return self::connection()->clean_nonces( $all );
5552
	}
5553
5554
	/**
5555
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5556
	 * SET: state( $key, $value );
5557
	 * GET: $value = state( $key );
5558
	 *
5559
	 * @param string $key
0 ignored issues
show
Documentation introduced by
Should the type for parameter $key not be string|null?

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

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

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

Loading history...
5560
	 * @param string $value
0 ignored issues
show
Documentation introduced by
Should the type for parameter $value not be string|null?

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

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

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

Loading history...
5561
	 * @param bool   $restate private
5562
	 */
5563
	public static function state( $key = null, $value = null, $restate = false ) {
5564
		static $state = array();
5565
		static $path, $domain;
5566
		if ( ! isset( $path ) ) {
5567
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5568
			$admin_url = self::admin_url();
5569
			$bits      = wp_parse_url( $admin_url );
5570
5571
			if ( is_array( $bits ) ) {
5572
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5573
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5574
			} else {
5575
				$path = $domain = null;
5576
			}
5577
		}
5578
5579
		// Extract state from cookies and delete cookies
5580
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5581
			$yum = $_COOKIE['jetpackState'];
5582
			unset( $_COOKIE['jetpackState'] );
5583
			foreach ( $yum as $k => $v ) {
5584
				if ( strlen( $v ) ) {
5585
					$state[ $k ] = $v;
5586
				}
5587
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5588
			}
5589
		}
5590
5591
		if ( $restate ) {
5592
			foreach ( $state as $k => $v ) {
5593
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5594
			}
5595
			return;
5596
		}
5597
5598
		// Get a state variable
5599
		if ( isset( $key ) && ! isset( $value ) ) {
5600
			if ( array_key_exists( $key, $state ) ) {
5601
				return $state[ $key ];
5602
			}
5603
			return null;
5604
		}
5605
5606
		// Set a state variable
5607
		if ( isset( $key ) && isset( $value ) ) {
5608
			if ( is_array( $value ) && isset( $value[0] ) ) {
5609
				$value = $value[0];
5610
			}
5611
			$state[ $key ] = $value;
5612
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5613
		}
5614
	}
5615
5616
	public static function restate() {
5617
		self::state( null, null, true );
5618
	}
5619
5620
	public static function check_privacy( $file ) {
5621
		static $is_site_publicly_accessible = null;
5622
5623
		if ( is_null( $is_site_publicly_accessible ) ) {
5624
			$is_site_publicly_accessible = false;
5625
5626
			$rpc = new Jetpack_IXR_Client();
5627
5628
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5629
			if ( $success ) {
5630
				$response = $rpc->getResponse();
5631
				if ( $response ) {
5632
					$is_site_publicly_accessible = true;
5633
				}
5634
			}
5635
5636
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5637
		}
5638
5639
		if ( $is_site_publicly_accessible ) {
5640
			return;
5641
		}
5642
5643
		$module_slug = self::get_module_slug( $file );
5644
5645
		$privacy_checks = self::state( 'privacy_checks' );
5646
		if ( ! $privacy_checks ) {
5647
			$privacy_checks = $module_slug;
5648
		} else {
5649
			$privacy_checks .= ",$module_slug";
5650
		}
5651
5652
		self::state( 'privacy_checks', $privacy_checks );
5653
	}
5654
5655
	/**
5656
	 * Helper method for multicall XMLRPC.
5657
	 *
5658
	 * @param ...$args Args for the async_call.
5659
	 */
5660
	public static function xmlrpc_async_call( ...$args ) {
5661
		global $blog_id;
5662
		static $clients = array();
5663
5664
		$client_blog_id = is_multisite() ? $blog_id : 0;
5665
5666
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5667
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5668
			if ( function_exists( 'ignore_user_abort' ) ) {
5669
				ignore_user_abort( true );
5670
			}
5671
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5672
		}
5673
5674
		if ( ! empty( $args[0] ) ) {
5675
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5676
		} elseif ( is_multisite() ) {
5677
			foreach ( $clients as $client_blog_id => $client ) {
5678
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5679
					continue;
5680
				}
5681
5682
				$switch_success = switch_to_blog( $client_blog_id, true );
5683
				if ( ! $switch_success ) {
5684
					continue;
5685
				}
5686
5687
				flush();
5688
				$client->query();
5689
5690
				restore_current_blog();
5691
			}
5692
		} else {
5693
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5694
				flush();
5695
				$clients[0]->query();
5696
			}
5697
		}
5698
	}
5699
5700
	public static function staticize_subdomain( $url ) {
5701
5702
		// Extract hostname from URL
5703
		$host = wp_parse_url( $url, PHP_URL_HOST );
5704
5705
		// Explode hostname on '.'
5706
		$exploded_host = explode( '.', $host );
5707
5708
		// Retrieve the name and TLD
5709
		if ( count( $exploded_host ) > 1 ) {
5710
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5711
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5712
			// Rebuild domain excluding subdomains
5713
			$domain = $name . '.' . $tld;
5714
		} else {
5715
			$domain = $host;
5716
		}
5717
		// Array of Automattic domains
5718
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5719
5720
		// Return $url if not an Automattic domain
5721
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5722
			return $url;
5723
		}
5724
5725
		if ( is_ssl() ) {
5726
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5727
		}
5728
5729
		srand( crc32( basename( $url ) ) );
5730
		$static_counter = rand( 0, 2 );
5731
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5732
5733
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5734
	}
5735
5736
	/* JSON API Authorization */
5737
5738
	/**
5739
	 * Handles the login action for Authorizing the JSON API
5740
	 */
5741
	function login_form_json_api_authorization() {
5742
		$this->verify_json_api_authorization_request();
5743
5744
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5745
5746
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5747
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5748
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5749
	}
5750
5751
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5752
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5753
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5754
			return $url;
5755
		}
5756
5757
		$parsed_url = wp_parse_url( $url );
5758
		$url        = strtok( $url, '?' );
5759
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5760
		if ( ! empty( $parsed_url['query'] ) ) {
5761
			$url .= "&{$parsed_url['query']}";
5762
		}
5763
5764
		return $url;
5765
	}
5766
5767
	// Make sure the POSTed request is handled by the same action
5768
	function preserve_action_in_login_form_for_json_api_authorization() {
5769
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5770
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5771
	}
5772
5773
	// If someone logs in to approve API access, store the Access Code in usermeta
5774
	function store_json_api_authorization_token( $user_login, $user ) {
5775
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5776
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5777
		$token = wp_generate_password( 32, false );
5778
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5779
	}
5780
5781
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5782
	function allow_wpcom_public_api_domain( $domains ) {
5783
		$domains[] = 'public-api.wordpress.com';
5784
		return $domains;
5785
	}
5786
5787
	static function is_redirect_encoded( $redirect_url ) {
5788
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5789
	}
5790
5791
	// Add all wordpress.com environments to the safe redirect whitelist
5792
	function allow_wpcom_environments( $domains ) {
5793
		$domains[] = 'wordpress.com';
5794
		$domains[] = 'wpcalypso.wordpress.com';
5795
		$domains[] = 'horizon.wordpress.com';
5796
		$domains[] = 'calypso.localhost';
5797
		return $domains;
5798
	}
5799
5800
	// Add the Access Code details to the public-api.wordpress.com redirect
5801
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5802
		return add_query_arg(
5803
			urlencode_deep(
5804
				array(
5805
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5806
					'jetpack-user-id' => (int) $user->ID,
5807
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5808
				)
5809
			),
5810
			$redirect_to
5811
		);
5812
	}
5813
5814
5815
	/**
5816
	 * Verifies the request by checking the signature
5817
	 *
5818
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5819
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5820
	 *
5821
	 * @param null|array $environment
5822
	 */
5823
	function verify_json_api_authorization_request( $environment = null ) {
5824
		$environment = is_null( $environment )
5825
			? $_REQUEST
5826
			: $environment;
5827
5828
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envVersion is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
5829
		$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...
5830
		if ( ! $token || empty( $token->secret ) ) {
5831
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5832
		}
5833
5834
		$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' );
5835
5836
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5837
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5838
			/**
5839
			 * Jetpack authorisation request Error.
5840
			 *
5841
			 * @since 7.5.0
5842
			 */
5843
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5844
			$die_error = sprintf(
5845
				/* translators: %s is a URL */
5846
				__( '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' ),
5847
				'https://jetpack.com/support/double-encoding/'
5848
			);
5849
		}
5850
5851
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5852
5853
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5854
			$signature = $jetpack_signature->sign_request(
5855
				$environment['token'],
5856
				$environment['timestamp'],
5857
				$environment['nonce'],
5858
				'',
5859
				'GET',
5860
				$environment['jetpack_json_api_original_query'],
5861
				null,
5862
				true
5863
			);
5864
		} else {
5865
			$signature = $jetpack_signature->sign_current_request(
5866
				array(
5867
					'body'   => null,
5868
					'method' => 'GET',
5869
				)
5870
			);
5871
		}
5872
5873
		if ( ! $signature ) {
5874
			wp_die( $die_error );
5875
		} elseif ( is_wp_error( $signature ) ) {
5876
			wp_die( $die_error );
5877
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
5878
			if ( is_ssl() ) {
5879
				// 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
5880
				$signature = $jetpack_signature->sign_current_request(
5881
					array(
5882
						'scheme' => 'http',
5883
						'body'   => null,
5884
						'method' => 'GET',
5885
					)
5886
				);
5887
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5888
					wp_die( $die_error );
5889
				}
5890
			} else {
5891
				wp_die( $die_error );
5892
			}
5893
		}
5894
5895
		$timestamp = (int) $environment['timestamp'];
5896
		$nonce     = stripslashes( (string) $environment['nonce'] );
5897
5898
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
5899
			// De-nonce the nonce, at least for 5 minutes.
5900
			// 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)
5901
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5902
			if ( $old_nonce_time < time() - 300 ) {
5903
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
5904
			}
5905
		}
5906
5907
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5908
		$data_filters = array(
5909
			'state'        => 'opaque',
5910
			'client_id'    => 'int',
5911
			'client_title' => 'string',
5912
			'client_image' => 'url',
5913
		);
5914
5915
		foreach ( $data_filters as $key => $sanitation ) {
5916
			if ( ! isset( $data->$key ) ) {
5917
				wp_die( $die_error );
5918
			}
5919
5920
			switch ( $sanitation ) {
5921
				case 'int':
5922
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
5923
					break;
5924
				case 'opaque':
5925
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
5926
					break;
5927
				case 'string':
5928
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
5929
					break;
5930
				case 'url':
5931
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
5932
					break;
5933
			}
5934
		}
5935
5936
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5937
			wp_die( $die_error );
5938
		}
5939
	}
5940
5941
	function login_message_json_api_authorization( $message ) {
5942
		return '<p class="message">' . sprintf(
5943
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
5944
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5945
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5946
	}
5947
5948
	/**
5949
	 * Get $content_width, but with a <s>twist</s> filter.
5950
	 */
5951
	public static function get_content_width() {
5952
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5953
			? $GLOBALS['content_width']
5954
			: false;
5955
		/**
5956
		 * Filter the Content Width value.
5957
		 *
5958
		 * @since 2.2.3
5959
		 *
5960
		 * @param string $content_width Content Width value.
5961
		 */
5962
		return apply_filters( 'jetpack_content_width', $content_width );
5963
	}
5964
5965
	/**
5966
	 * Pings the WordPress.com Mirror Site for the specified options.
5967
	 *
5968
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5969
	 *
5970
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5971
	 */
5972
	public function get_cloud_site_options( $option_names ) {
5973
		$option_names = array_filter( (array) $option_names, 'is_string' );
5974
5975
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
5976
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5977
		if ( $xml->isError() ) {
5978
			return array(
5979
				'error_code' => $xml->getErrorCode(),
5980
				'error_msg'  => $xml->getErrorMessage(),
5981
			);
5982
		}
5983
		$cloud_site_options = $xml->getResponse();
5984
5985
		return $cloud_site_options;
5986
	}
5987
5988
	/**
5989
	 * Checks if the site is currently in an identity crisis.
5990
	 *
5991
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5992
	 */
5993
	public static function check_identity_crisis() {
5994
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5995
			return false;
5996
		}
5997
5998
		return Jetpack_Options::get_option( 'sync_error_idc' );
5999
	}
6000
6001
	/**
6002
	 * Checks whether the home and siteurl specifically are whitelisted
6003
	 * Written so that we don't have re-check $key and $value params every time
6004
	 * we want to check if this site is whitelisted, for example in footer.php
6005
	 *
6006
	 * @since  3.8.0
6007
	 * @return bool True = already whitelisted False = not whitelisted
6008
	 */
6009
	public static function is_staging_site() {
6010
		$is_staging = false;
6011
6012
		$known_staging = array(
6013
			'urls'      => array(
6014
				'#\.staging\.wpengine\.com$#i', // WP Engine
6015
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6016
				'#\.stage\.site$#i',            // DreamPress
6017
			),
6018
			'constants' => array(
6019
				'IS_WPE_SNAPSHOT',      // WP Engine
6020
				'KINSTA_DEV_ENV',       // Kinsta.com
6021
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6022
				'JETPACK_STAGING_MODE', // Generic
6023
			),
6024
		);
6025
		/**
6026
		 * Filters the flags of known staging sites.
6027
		 *
6028
		 * @since 3.9.0
6029
		 *
6030
		 * @param array $known_staging {
6031
		 *     An array of arrays that each are used to check if the current site is staging.
6032
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6033
		 *     @type array $constants PHP constants of known staging/developement environments.
6034
		 *  }
6035
		 */
6036
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6037
6038
		if ( isset( $known_staging['urls'] ) ) {
6039
			foreach ( $known_staging['urls'] as $url ) {
6040
				if ( preg_match( $url, site_url() ) ) {
6041
					$is_staging = true;
6042
					break;
6043
				}
6044
			}
6045
		}
6046
6047
		if ( isset( $known_staging['constants'] ) ) {
6048
			foreach ( $known_staging['constants'] as $constant ) {
6049
				if ( defined( $constant ) && constant( $constant ) ) {
6050
					$is_staging = true;
6051
				}
6052
			}
6053
		}
6054
6055
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6056
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6057
			$is_staging = true;
6058
		}
6059
6060
		/**
6061
		 * Filters is_staging_site check.
6062
		 *
6063
		 * @since 3.9.0
6064
		 *
6065
		 * @param bool $is_staging If the current site is a staging site.
6066
		 */
6067
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6068
	}
6069
6070
	/**
6071
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6072
	 *
6073
	 * @since 4.4.0
6074
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6075
	 *
6076
	 * @return bool
6077
	 */
6078
	public static function validate_sync_error_idc_option() {
6079
		$is_valid = false;
6080
6081
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6082
		if ( false === $idc_allowed ) {
6083
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6084
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6085
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6086
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6087
				$transient_duration = HOUR_IN_SECONDS;
6088
			} else {
6089
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6090
				$idc_allowed        = '1';
6091
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6092
			}
6093
6094
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6095
		}
6096
6097
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6098
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6099
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6100
			$local_options = self::get_sync_error_idc_option();
6101
			// Ensure all values are set.
6102
			if ( isset( $sync_error['home'] ) && isset ( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6103
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6104
					$is_valid = true;
6105
				}
6106
			}
6107
6108
		}
6109
6110
		/**
6111
		 * Filters whether the sync_error_idc option is valid.
6112
		 *
6113
		 * @since 4.4.0
6114
		 *
6115
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6116
		 */
6117
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6118
6119
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6120
			// Since the option exists, and did not validate, delete it
6121
			Jetpack_Options::delete_option( 'sync_error_idc' );
6122
		}
6123
6124
		return $is_valid;
6125
	}
6126
6127
	/**
6128
	 * Normalizes a url by doing three things:
6129
	 *  - Strips protocol
6130
	 *  - Strips www
6131
	 *  - Adds a trailing slash
6132
	 *
6133
	 * @since 4.4.0
6134
	 * @param string $url
6135
	 * @return WP_Error|string
6136
	 */
6137
	public static function normalize_url_protocol_agnostic( $url ) {
6138
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6139
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6140
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'cannot_parse_url'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
6141
		}
6142
6143
		// Strip www and protocols
6144
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6145
		return $url;
6146
	}
6147
6148
	/**
6149
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6150
	 *
6151
	 * @since 4.4.0
6152
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6153
	 *
6154
	 * @param array $response
6155
	 * @return array Array of the local urls, wpcom urls, and error code
6156
	 */
6157
	public static function get_sync_error_idc_option( $response = array() ) {
6158
		// Since the local options will hit the database directly, store the values
6159
		// in a transient to allow for autoloading and caching on subsequent views.
6160
		$local_options = get_transient( 'jetpack_idc_local' );
6161
		if ( false === $local_options ) {
6162
			$local_options = array(
6163
				'home'    => Functions::home_url(),
6164
				'siteurl' => Functions::site_url(),
6165
			);
6166
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6167
		}
6168
6169
		$options = array_merge( $local_options, $response );
6170
6171
		$returned_values = array();
6172
		foreach ( $options as $key => $option ) {
6173
			if ( 'error_code' === $key ) {
6174
				$returned_values[ $key ] = $option;
6175
				continue;
6176
			}
6177
6178
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6179
				continue;
6180
			}
6181
6182
			$returned_values[ $key ] = $normalized_url;
6183
		}
6184
6185
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6186
6187
		return $returned_values;
6188
	}
6189
6190
	/**
6191
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6192
	 * If set to true, the site will be put into staging mode.
6193
	 *
6194
	 * @since 4.3.2
6195
	 * @return bool
6196
	 */
6197
	public static function sync_idc_optin() {
6198
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6199
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6200
		} else {
6201
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6202
		}
6203
6204
		/**
6205
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6206
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6207
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6208
		 *
6209
		 * @since 4.3.2
6210
		 *
6211
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6212
		 */
6213
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6214
	}
6215
6216
	/**
6217
	 * Maybe Use a .min.css stylesheet, maybe not.
6218
	 *
6219
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6220
	 */
6221
	public static function maybe_min_asset( $url, $path, $plugin ) {
6222
		// Short out on things trying to find actual paths.
6223
		if ( ! $path || empty( $plugin ) ) {
6224
			return $url;
6225
		}
6226
6227
		$path = ltrim( $path, '/' );
6228
6229
		// Strip out the abspath.
6230
		$base = dirname( plugin_basename( $plugin ) );
6231
6232
		// Short out on non-Jetpack assets.
6233
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6234
			return $url;
6235
		}
6236
6237
		// File name parsing.
6238
		$file              = "{$base}/{$path}";
6239
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6240
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6241
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6242
		$extension         = array_shift( $file_name_parts_r );
6243
6244
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6245
			// Already pointing at the minified version.
6246
			if ( 'min' === $file_name_parts_r[0] ) {
6247
				return $url;
6248
			}
6249
6250
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6251
			if ( file_exists( $min_full_path ) ) {
6252
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6253
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6254
				if ( 'css' === $extension ) {
6255
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6256
					self::$min_assets[ $key ] = $path;
6257
				}
6258
			}
6259
		}
6260
6261
		return $url;
6262
	}
6263
6264
	/**
6265
	 * If the asset is minified, let's flag .min as the suffix.
6266
	 *
6267
	 * Attached to `style_loader_src` filter.
6268
	 *
6269
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
Bug introduced by
There is no parameter named $tag. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6270
	 * @param string $handle The registered handle of the script in question.
6271
	 * @param string $href The url of the asset in question.
0 ignored issues
show
Bug introduced by
There is no parameter named $href. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6272
	 */
6273
	public static function set_suffix_on_min( $src, $handle ) {
6274
		if ( false === strpos( $src, '.min.css' ) ) {
6275
			return $src;
6276
		}
6277
6278
		if ( ! empty( self::$min_assets ) ) {
6279
			foreach ( self::$min_assets as $file => $path ) {
6280
				if ( false !== strpos( $src, $file ) ) {
6281
					wp_style_add_data( $handle, 'suffix', '.min' );
6282
					return $src;
6283
				}
6284
			}
6285
		}
6286
6287
		return $src;
6288
	}
6289
6290
	/**
6291
	 * Maybe inlines a stylesheet.
6292
	 *
6293
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6294
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6295
	 *
6296
	 * Attached to `style_loader_tag` filter.
6297
	 *
6298
	 * @param string $tag The tag that would link to the external asset.
6299
	 * @param string $handle The registered handle of the script in question.
6300
	 *
6301
	 * @return string
6302
	 */
6303
	public static function maybe_inline_style( $tag, $handle ) {
6304
		global $wp_styles;
6305
		$item = $wp_styles->registered[ $handle ];
6306
6307
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6308
			return $tag;
6309
		}
6310
6311
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6312
			$href = $matches[1];
6313
			// Strip off query string
6314
			if ( $pos = strpos( $href, '?' ) ) {
6315
				$href = substr( $href, 0, $pos );
6316
			}
6317
			// Strip off fragment
6318
			if ( $pos = strpos( $href, '#' ) ) {
6319
				$href = substr( $href, 0, $pos );
6320
			}
6321
		} else {
6322
			return $tag;
6323
		}
6324
6325
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6326
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6327
			return $tag;
6328
		}
6329
6330
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6331
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6332
			// And this isn't the pass that actually deals with the RTL version...
6333
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6334
				// Short out, as the RTL version will deal with it in a moment.
6335
				return $tag;
6336
			}
6337
		}
6338
6339
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6340
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6341
		if ( $css ) {
6342
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6343
			if ( empty( $item->extra['after'] ) ) {
6344
				wp_add_inline_style( $handle, $css );
6345
			} else {
6346
				array_unshift( $item->extra['after'], $css );
6347
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6348
			}
6349
		}
6350
6351
		return $tag;
6352
	}
6353
6354
	/**
6355
	 * Loads a view file from the views
6356
	 *
6357
	 * Data passed in with the $data parameter will be available in the
6358
	 * template file as $data['value']
6359
	 *
6360
	 * @param string $template - Template file to load
6361
	 * @param array  $data - Any data to pass along to the template
6362
	 * @return boolean - If template file was found
6363
	 **/
6364
	public function load_view( $template, $data = array() ) {
6365
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6366
6367
		if ( file_exists( $views_dir . $template ) ) {
6368
			require_once $views_dir . $template;
6369
			return true;
6370
		}
6371
6372
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6373
		return false;
6374
	}
6375
6376
	/**
6377
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6378
	 */
6379
	public function deprecated_hooks() {
6380
		global $wp_filter;
6381
6382
		/*
6383
		 * Format:
6384
		 * deprecated_filter_name => replacement_name
6385
		 *
6386
		 * If there is no replacement, use null for replacement_name
6387
		 */
6388
		$deprecated_list = array(
6389
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6390
			'wpl_sharing_2014_1'                           => null,
6391
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6392
			'jetpack_identity_crisis_options_to_check'     => null,
6393
			'update_option_jetpack_single_user_site'       => null,
6394
			'audio_player_default_colors'                  => null,
6395
			'add_option_jetpack_featured_images_enabled'   => null,
6396
			'add_option_jetpack_update_details'            => null,
6397
			'add_option_jetpack_updates'                   => null,
6398
			'add_option_jetpack_network_name'              => null,
6399
			'add_option_jetpack_network_allow_new_registrations' => null,
6400
			'add_option_jetpack_network_add_new_users'     => null,
6401
			'add_option_jetpack_network_site_upload_space' => null,
6402
			'add_option_jetpack_network_upload_file_types' => null,
6403
			'add_option_jetpack_network_enable_administration_menus' => null,
6404
			'add_option_jetpack_is_multi_site'             => null,
6405
			'add_option_jetpack_is_main_network'           => null,
6406
			'add_option_jetpack_main_network_site'         => null,
6407
			'jetpack_sync_all_registered_options'          => null,
6408
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6409
			'jetpack_is_post_mailable'                     => null,
6410
			'jetpack_seo_site_host'                        => null,
6411
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6412
			'jetpack_holiday_snow_option_name'             => null,
6413
			'jetpack_holiday_chance_of_snow'               => null,
6414
			'jetpack_holiday_snow_js_url'                  => null,
6415
			'jetpack_is_holiday_snow_season'               => null,
6416
			'jetpack_holiday_snow_option_updated'          => null,
6417
			'jetpack_holiday_snowing'                      => null,
6418
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6419
			'jetpack_cache_plans'                          => null,
6420
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6421
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6422
			'jetpack_enable_site_verification'             => null,
6423
			'can_display_jetpack_manage_notice'            => null,
6424
			// Removed in Jetpack 7.3.0
6425
			'atd_load_scripts'                             => null,
6426
			'atd_http_post_timeout'                        => null,
6427
			'atd_http_post_error'                          => null,
6428
			'atd_service_domain'                           => null,
6429
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6430
			// Removed in Jetpack 7.9.0
6431
			'jetpack_pwa_manifest'                         => null,
6432
			'jetpack_pwa_background_color'                 => null,
6433
		);
6434
6435
		// This is a silly loop depth. Better way?
6436
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6437
			if ( has_action( $hook ) ) {
6438
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6439
					foreach ( $values as $hooked ) {
6440
						if ( is_callable( $hooked['function'] ) ) {
6441
							$function_name = 'an anonymous function';
6442
						} else {
6443
							$function_name = $hooked['function'];
6444
						}
6445
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6446
					}
6447
				}
6448
			}
6449
		}
6450
	}
6451
6452
	/**
6453
	 * Converts any url in a stylesheet, to the correct absolute url.
6454
	 *
6455
	 * Considerations:
6456
	 *  - Normal, relative URLs     `feh.png`
6457
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6458
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6459
	 *  - Absolute URLs             `http://domain.com/feh.png`
6460
	 *  - Domain root relative URLs `/feh.png`
6461
	 *
6462
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6463
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6464
	 *
6465
	 * @return mixed|string
6466
	 */
6467
	public static function absolutize_css_urls( $css, $css_file_url ) {
6468
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6469
		$css_dir = dirname( $css_file_url );
6470
		$p       = wp_parse_url( $css_dir );
6471
		$domain  = sprintf(
6472
			'%1$s//%2$s%3$s%4$s',
6473
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6474
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6475
			$p['host'],
6476
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6477
		);
6478
6479
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6480
			$find = $replace = array();
6481
			foreach ( $matches as $match ) {
6482
				$url = trim( $match['path'], "'\" \t" );
6483
6484
				// If this is a data url, we don't want to mess with it.
6485
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6486
					continue;
6487
				}
6488
6489
				// If this is an absolute or protocol-agnostic url,
6490
				// we don't want to mess with it.
6491
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6492
					continue;
6493
				}
6494
6495
				switch ( substr( $url, 0, 1 ) ) {
6496
					case '/':
6497
						$absolute = $domain . $url;
6498
						break;
6499
					default:
6500
						$absolute = $css_dir . '/' . $url;
6501
				}
6502
6503
				$find[]    = $match[0];
6504
				$replace[] = sprintf( 'url("%s")', $absolute );
6505
			}
6506
			$css = str_replace( $find, $replace, $css );
6507
		}
6508
6509
		return $css;
6510
	}
6511
6512
	/**
6513
	 * This methods removes all of the registered css files on the front end
6514
	 * from Jetpack in favor of using a single file. In effect "imploding"
6515
	 * all the files into one file.
6516
	 *
6517
	 * Pros:
6518
	 * - Uses only ONE css asset connection instead of 15
6519
	 * - Saves a minimum of 56k
6520
	 * - Reduces server load
6521
	 * - Reduces time to first painted byte
6522
	 *
6523
	 * Cons:
6524
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6525
	 *      should not cause any issues with themes.
6526
	 * - Plugins/themes dequeuing styles no longer do anything. See
6527
	 *      jetpack_implode_frontend_css filter for a workaround
6528
	 *
6529
	 * For some situations developers may wish to disable css imploding and
6530
	 * instead operate in legacy mode where each file loads seperately and
6531
	 * can be edited individually or dequeued. This can be accomplished with
6532
	 * the following line:
6533
	 *
6534
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6535
	 *
6536
	 * @since 3.2
6537
	 **/
6538
	public function implode_frontend_css( $travis_test = false ) {
6539
		$do_implode = true;
6540
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6541
			$do_implode = false;
6542
		}
6543
6544
		// Do not implode CSS when the page loads via the AMP plugin.
6545
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6546
			$do_implode = false;
6547
		}
6548
6549
		/**
6550
		 * Allow CSS to be concatenated into a single jetpack.css file.
6551
		 *
6552
		 * @since 3.2.0
6553
		 *
6554
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6555
		 */
6556
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6557
6558
		// Do not use the imploded file when default behavior was altered through the filter
6559
		if ( ! $do_implode ) {
6560
			return;
6561
		}
6562
6563
		// We do not want to use the imploded file in dev mode, or if not connected
6564
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6565
			if ( ! $travis_test ) {
6566
				return;
6567
			}
6568
		}
6569
6570
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6571
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6572
			return;
6573
		}
6574
6575
		/*
6576
		 * Now we assume Jetpack is connected and able to serve the single
6577
		 * file.
6578
		 *
6579
		 * In the future there will be a check here to serve the file locally
6580
		 * or potentially from the Jetpack CDN
6581
		 *
6582
		 * For now:
6583
		 * - Enqueue a single imploded css file
6584
		 * - Zero out the style_loader_tag for the bundled ones
6585
		 * - Be happy, drink scotch
6586
		 */
6587
6588
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6589
6590
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6591
6592
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6593
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6594
	}
6595
6596
	function concat_remove_style_loader_tag( $tag, $handle ) {
6597
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6598
			$tag = '';
6599
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6600
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6601
			}
6602
		}
6603
6604
		return $tag;
6605
	}
6606
6607
	/**
6608
	 * Add an async attribute to scripts that can be loaded asynchronously.
6609
	 * https://www.w3schools.com/tags/att_script_async.asp
6610
	 *
6611
	 * @since 7.7.0
6612
	 *
6613
	 * @param string $tag    The <script> tag for the enqueued script.
6614
	 * @param string $handle The script's registered handle.
6615
	 * @param string $src    The script's source URL.
6616
	 */
6617
	public function script_add_async( $tag, $handle, $src ) {
6618
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6619
			return preg_replace( '/^<script /i', '<script async ', $tag );
6620
		}
6621
6622
		return $tag;
6623
	}
6624
6625
	/*
6626
	 * Check the heartbeat data
6627
	 *
6628
	 * Organizes the heartbeat data by severity.  For example, if the site
6629
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6630
	 *
6631
	 * Data will be added to "caution" array, if it either:
6632
	 *  - Out of date Jetpack version
6633
	 *  - Out of date WP version
6634
	 *  - Out of date PHP version
6635
	 *
6636
	 * $return array $filtered_data
6637
	 */
6638
	public static function jetpack_check_heartbeat_data() {
6639
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6640
6641
		$good    = array();
6642
		$caution = array();
6643
		$bad     = array();
6644
6645
		foreach ( $raw_data as $stat => $value ) {
6646
6647
			// Check jetpack version
6648
			if ( 'version' == $stat ) {
6649
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6650
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6651
					continue;
6652
				}
6653
			}
6654
6655
			// Check WP version
6656
			if ( 'wp-version' == $stat ) {
6657
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6658
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6659
					continue;
6660
				}
6661
			}
6662
6663
			// Check PHP version
6664
			if ( 'php-version' == $stat ) {
6665
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6666
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_PHP_VERSION;
6667
					continue;
6668
				}
6669
			}
6670
6671
			// Check ID crisis
6672
			if ( 'identitycrisis' == $stat ) {
6673
				if ( 'yes' == $value ) {
6674
					$bad[ $stat ] = $value;
6675
					continue;
6676
				}
6677
			}
6678
6679
			// The rest are good :)
6680
			$good[ $stat ] = $value;
6681
		}
6682
6683
		$filtered_data = array(
6684
			'good'    => $good,
6685
			'caution' => $caution,
6686
			'bad'     => $bad,
6687
		);
6688
6689
		return $filtered_data;
6690
	}
6691
6692
6693
	/*
6694
	 * This method is used to organize all options that can be reset
6695
	 * without disconnecting Jetpack.
6696
	 *
6697
	 * It is used in class.jetpack-cli.php to reset options
6698
	 *
6699
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6700
	 *
6701
	 * @return array of options to delete.
6702
	 */
6703
	public static function get_jetpack_options_for_reset() {
6704
		return Jetpack_Options::get_options_for_reset();
6705
	}
6706
6707
	/*
6708
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6709
	 * so we can bring them directly to their site in calypso.
6710
	 *
6711
	 * @param string | url
6712
	 * @return string | url without the guff
6713
	 */
6714
	public static function build_raw_urls( $url ) {
6715
		$strip_http = '/.*?:\/\//i';
6716
		$url        = preg_replace( $strip_http, '', $url );
6717
		$url        = str_replace( '/', '::', $url );
6718
		return $url;
6719
	}
6720
6721
	/**
6722
	 * Stores and prints out domains to prefetch for page speed optimization.
6723
	 *
6724
	 * @param mixed $new_urls
6725
	 */
6726
	public static function dns_prefetch( $new_urls = null ) {
6727
		static $prefetch_urls = array();
6728
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6729
			echo "\r\n";
6730
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6731
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6732
			}
6733
		} elseif ( ! empty( $new_urls ) ) {
6734
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6735
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6736
			}
6737
			foreach ( (array) $new_urls as $this_new_url ) {
6738
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6739
			}
6740
			$prefetch_urls = array_unique( $prefetch_urls );
6741
		}
6742
	}
6743
6744
	public function wp_dashboard_setup() {
6745
		if ( self::is_active() ) {
6746
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6747
		}
6748
6749
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6750
			$jetpack_logo = new Jetpack_Logo();
6751
			$widget_title = sprintf(
6752
				wp_kses(
6753
					/* translators: Placeholder is a Jetpack logo. */
6754
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6755
					array( 'span' => array() )
6756
				),
6757
				$jetpack_logo->get_jp_emblem( true )
6758
			);
6759
6760
			wp_add_dashboard_widget(
6761
				'jetpack_summary_widget',
6762
				$widget_title,
6763
				array( __CLASS__, 'dashboard_widget' )
6764
			);
6765
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6766
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6767
6768
			// If we're inactive and not in development mode, sort our box to the top.
6769
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6770
				global $wp_meta_boxes;
6771
6772
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6773
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6774
6775
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6776
			}
6777
		}
6778
	}
6779
6780
	/**
6781
	 * @param mixed $result Value for the user's option
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6782
	 * @return mixed
6783
	 */
6784
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6785
		if ( ! is_array( $sorted ) ) {
6786
			return $sorted;
6787
		}
6788
6789
		foreach ( $sorted as $box_context => $ids ) {
6790
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6791
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6792
				continue;
6793
			}
6794
6795
			$ids_array = explode( ',', $ids );
6796
			$key       = array_search( 'dashboard_stats', $ids_array );
6797
6798
			if ( false !== $key ) {
6799
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6800
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6801
				$sorted[ $box_context ] = implode( ',', $ids_array );
6802
				// We've found it, stop searching, and just return.
6803
				break;
6804
			}
6805
		}
6806
6807
		return $sorted;
6808
	}
6809
6810
	public static function dashboard_widget() {
6811
		/**
6812
		 * Fires when the dashboard is loaded.
6813
		 *
6814
		 * @since 3.4.0
6815
		 */
6816
		do_action( 'jetpack_dashboard_widget' );
6817
	}
6818
6819
	public static function dashboard_widget_footer() {
6820
		?>
6821
		<footer>
6822
6823
		<div class="protect">
6824
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6825
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6826
				<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>
6827
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
6828
				<a href="
6829
				<?php
6830
				echo esc_url(
6831
					wp_nonce_url(
6832
						self::admin_url(
6833
							array(
6834
								'action' => 'activate',
6835
								'module' => 'protect',
6836
							)
6837
						),
6838
						'jetpack_activate-protect'
6839
					)
6840
				);
6841
				?>
6842
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6843
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6844
				</a>
6845
			<?php else : ?>
6846
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6847
			<?php endif; ?>
6848
		</div>
6849
6850
		<div class="akismet">
6851
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6852
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6853
				<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>
6854
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6855
				<a href="
6856
				<?php
6857
				echo esc_url(
6858
					wp_nonce_url(
6859
						add_query_arg(
6860
							array(
6861
								'action' => 'activate',
6862
								'plugin' => 'akismet/akismet.php',
6863
							),
6864
							admin_url( 'plugins.php' )
6865
						),
6866
						'activate-plugin_akismet/akismet.php'
6867
					)
6868
				);
6869
				?>
6870
							" class="button button-jetpack">
6871
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6872
				</a>
6873
			<?php else : ?>
6874
				<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>
6875
			<?php endif; ?>
6876
		</div>
6877
6878
		</footer>
6879
		<?php
6880
	}
6881
6882
	/*
6883
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6884
	 */
6885
	function jetpack_icon_user_connected( $columns ) {
6886
		$columns['user_jetpack'] = '';
6887
		return $columns;
6888
	}
6889
6890
	/*
6891
	 * Show Jetpack icon if the user is linked.
6892
	 */
6893
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6894
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
6895
			$jetpack_logo = new Jetpack_Logo();
6896
			$emblem_html  = sprintf(
6897
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6898
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6899
				$jetpack_logo->get_jp_emblem()
6900
			);
6901
			return $emblem_html;
6902
		}
6903
6904
		return $val;
6905
	}
6906
6907
	/*
6908
	 * Style the Jetpack user column
6909
	 */
6910
	function jetpack_user_col_style() {
6911
		global $current_screen;
6912
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
6913
			?>
6914
			<style>
6915
				.fixed .column-user_jetpack {
6916
					width: 21px;
6917
				}
6918
				.jp-emblem-user-admin svg {
6919
					width: 20px;
6920
					height: 20px;
6921
				}
6922
				.jp-emblem-user-admin path {
6923
					fill: #00BE28;
6924
				}
6925
			</style>
6926
			<?php
6927
		}
6928
	}
6929
6930
	/**
6931
	 * Checks if Akismet is active and working.
6932
	 *
6933
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6934
	 * that implied usage of methods present since more recent version.
6935
	 * See https://github.com/Automattic/jetpack/pull/9585
6936
	 *
6937
	 * @since  5.1.0
6938
	 *
6939
	 * @return bool True = Akismet available. False = Aksimet not available.
6940
	 */
6941
	public static function is_akismet_active() {
6942
		static $status = null;
6943
6944
		if ( ! is_null( $status ) ) {
6945
			return $status;
6946
		}
6947
6948
		// Check if a modern version of Akismet is active.
6949
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6950
			$status = false;
6951
			return $status;
6952
		}
6953
6954
		// Make sure there is a key known to Akismet at all before verifying key.
6955
		$akismet_key = Akismet::get_api_key();
6956
		if ( ! $akismet_key ) {
6957
			$status = false;
6958
			return $status;
6959
		}
6960
6961
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6962
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6963
6964
		// 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.
6965
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6966
		// We cache the result of the Akismet key verification for ten minutes.
6967
		if ( ! $akismet_key_state || $recheck ) {
6968
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6969
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6970
		}
6971
6972
		$status = 'valid' === $akismet_key_state;
6973
6974
		return $status;
6975
	}
6976
6977
	/**
6978
	 * @deprecated
6979
	 *
6980
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
6981
	 */
6982
	public static function is_function_in_backtrace() {
6983
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
6984
	}
6985
6986
	/**
6987
	 * Given a minified path, and a non-minified path, will return
6988
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6989
	 *
6990
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6991
	 * root Jetpack directory.
6992
	 *
6993
	 * @since 5.6.0
6994
	 *
6995
	 * @param string $min_path
6996
	 * @param string $non_min_path
6997
	 * @return string The URL to the file
6998
	 */
6999
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7000
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7001
	}
7002
7003
	/**
7004
	 * Checks for whether Jetpack Backup & Scan is enabled.
7005
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
7006
	 *
7007
	 * @return bool|int|mixed
7008
	 */
7009
	public static function is_rewind_enabled() {
7010
		if ( ! self::is_active() ) {
7011
			return false;
7012
		}
7013
7014
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7015
		if ( false === $rewind_enabled ) {
7016
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7017
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7018
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7019
				&& ! empty( $rewind_data['state'] )
7020
				&& 'active' === $rewind_data['state'] )
7021
				? 1
7022
				: 0;
7023
7024
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7025
		}
7026
		return $rewind_enabled;
7027
	}
7028
7029
	/**
7030
	 * Return Calypso environment value; used for developing Jetpack and pairing
7031
	 * it with different Calypso enrionments, such as localhost.
7032
	 *
7033
	 * @since 7.4.0
7034
	 *
7035
	 * @return string Calypso environment
7036
	 */
7037
	public static function get_calypso_env() {
7038
		if ( isset( $_GET['calypso_env'] ) ) {
7039
			return sanitize_key( $_GET['calypso_env'] );
7040
		}
7041
7042
		if ( getenv( 'CALYPSO_ENV' ) ) {
7043
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7044
		}
7045
7046
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7047
			return sanitize_key( CALYPSO_ENV );
7048
		}
7049
7050
		return '';
7051
	}
7052
7053
	/**
7054
	 * Checks whether or not TOS has been agreed upon.
7055
	 * Will return true if a user has clicked to register, or is already connected.
7056
	 */
7057
	public static function jetpack_tos_agreed() {
7058
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7059
7060
		$terms_of_service = new Terms_Of_Service();
7061
		return $terms_of_service->has_agreed();
7062
7063
	}
7064
7065
	/**
7066
	 * Handles activating default modules as well general cleanup for the new connection.
7067
	 *
7068
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7069
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7070
	 * @param boolean $send_state_messages          Whether to send state messages.
7071
	 * @return void
7072
	 */
7073
	public static function handle_post_authorization_actions(
7074
		$activate_sso = false,
7075
		$redirect_on_activation_error = false,
7076
		$send_state_messages = true
7077
	) {
7078
		$other_modules = $activate_sso
7079
			? array( 'sso' )
7080
			: array();
7081
7082
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7083
			self::delete_active_modules();
7084
7085
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
Documentation introduced by
999 is of type integer, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
7086
		} else {
7087
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7088
		}
7089
7090
		// Since this is a fresh connection, be sure to clear out IDC options
7091
		Jetpack_IDC::clear_all_idc_options();
7092
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7093
7094
		// Start nonce cleaner
7095
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7096
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7097
7098
		if ( $send_state_messages ) {
7099
			self::state( 'message', 'authorized' );
7100
		}
7101
	}
7102
7103
	/**
7104
	 * Returns a boolean for whether backups UI should be displayed or not.
7105
	 *
7106
	 * @return bool Should backups UI be displayed?
7107
	 */
7108
	public static function show_backups_ui() {
7109
		/**
7110
		 * Whether UI for backups should be displayed.
7111
		 *
7112
		 * @since 6.5.0
7113
		 *
7114
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7115
		 */
7116
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7117
	}
7118
7119
	/*
7120
	 * Deprecated manage functions
7121
	 */
7122
	function prepare_manage_jetpack_notice() {
7123
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7124
	}
7125
	function manage_activate_screen() {
7126
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7127
	}
7128
	function admin_jetpack_manage_notice() {
7129
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7130
	}
7131
	function opt_out_jetpack_manage_url() {
7132
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7133
	}
7134
	function opt_in_jetpack_manage_url() {
7135
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7136
	}
7137
	function opt_in_jetpack_manage_notice() {
7138
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7139
	}
7140
	function can_display_jetpack_manage_notice() {
7141
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7142
	}
7143
7144
	/**
7145
	 * Clean leftoveruser meta.
7146
	 *
7147
	 * Delete Jetpack-related user meta when it is no longer needed.
7148
	 *
7149
	 * @since 7.3.0
7150
	 *
7151
	 * @param int $user_id User ID being updated.
7152
	 */
7153
	public static function user_meta_cleanup( $user_id ) {
7154
		$meta_keys = array(
7155
			// AtD removed from Jetpack 7.3
7156
			'AtD_options',
7157
			'AtD_check_when',
7158
			'AtD_guess_lang',
7159
			'AtD_ignored_phrases',
7160
		);
7161
7162
		foreach ( $meta_keys as $meta_key ) {
7163
			if ( get_user_meta( $user_id, $meta_key ) ) {
7164
				delete_user_meta( $user_id, $meta_key );
7165
			}
7166
		}
7167
	}
7168
7169
	/**
7170
	 * Checks if a Jetpack site is both active and not in development.
7171
	 *
7172
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7173
	 *
7174
	 * @return bool True if Jetpack is active and not in development.
7175
	 */
7176
	public static function is_active_and_not_development_mode() {
7177
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7178
			return false;
7179
		}
7180
		return true;
7181
	}
7182
}
7183