Completed
Push — add/disconnect-blog-tokens-con... ( 8f0af7 )
by
unknown
21:20 queued 14:13
created

Jetpack::build_authorize_url()   A

Complexity

Conditions 3
Paths 4

Size

Total Lines 23

Duplication

Lines 0
Ratio 0 %

Importance

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