Completed
Push — add/single-product-backup-body... ( 4e109f...285f8e )
by
unknown
16:57 queued 09:31
created

Jetpack::authorize_ending_linked()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

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