Completed
Push — renovate/sirbrillig-phpcs-chan... ( ecf5f1...bc80b5 )
by Jeremy
125:13 queued 118:57
created

Jetpack::configure()   B

Complexity

Conditions 9
Paths 96

Size

Total Lines 58

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 9
nc 96
nop 0
dl 0
loc 58
rs 7.3608
c 0
b 0
f 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\Config;
5
use Automattic\Jetpack\Connection\Client;
6
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
7
use Automattic\Jetpack\Connection\Utils as Connection_Utils;
8
use Automattic\Jetpack\Constants;
9
use Automattic\Jetpack\Partner;
10
use Automattic\Jetpack\Roles;
11
use Automattic\Jetpack\Status;
12
use Automattic\Jetpack\Sync\Functions;
13
use Automattic\Jetpack\Sync\Health;
14
use Automattic\Jetpack\Sync\Sender;
15
use Automattic\Jetpack\Sync\Users;
16
use Automattic\Jetpack\Terms_Of_Service;
17
use Automattic\Jetpack\Tracking;
18
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
19
use Automattic\Jetpack\Redirect;
20
21
/*
22
Options:
23
jetpack_options (array)
24
	An array of options.
25
	@see Jetpack_Options::get_option_names()
26
27
jetpack_register (string)
28
	Temporary verification secrets.
29
30
jetpack_activated (int)
31
	1: the plugin was activated normally
32
	2: the plugin was activated on this site because of a network-wide activation
33
	3: the plugin was auto-installed
34
	4: the plugin was manually disconnected (but is still installed)
35
36
jetpack_active_modules (array)
37
	Array of active module slugs.
38
39
jetpack_do_activate (bool)
40
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
41
*/
42
43
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
44
45
class Jetpack {
46
	public $xmlrpc_server = null;
47
48
	private $rest_authentication_status = null;
49
50
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
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
		'latex'              => array(
173
			'LaTeX for WordPress'     => 'latex/latex.php',
174
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
175
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
176
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
177
			'Enable Latex'            => 'enable-latex/enable-latex.php',
178
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
179
		),
180
		'protect'            => array(
181
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
182
			'Captcha'                           => 'captcha/captcha.php',
183
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
184
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
185
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
186
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
187
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
188
			'Security-protection'               => 'security-protection/security-protection.php',
189
			'Login Security'                    => 'login-security/login-security.php',
190
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
191
			'Wordfence Security'                => 'wordfence/wordfence.php',
192
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
193
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
194
		),
195
		'random-redirect'    => array(
196
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
197
		),
198
		'related-posts'      => array(
199
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
200
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
201
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
202
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
203
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
204
			'outbrain'                    => 'outbrain/outbrain.php',
205
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
206
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
207
		),
208
		'sharedaddy'         => array(
209
			'AddThis'     => 'addthis/addthis_social_widget.php',
210
			'Add To Any'  => 'add-to-any/add-to-any.php',
211
			'ShareThis'   => 'share-this/sharethis.php',
212
			'Shareaholic' => 'shareaholic/shareaholic.php',
213
		),
214
		'seo-tools'          => array(
215
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
216
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
217
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
218
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
219
			'The SEO Framework'              => 'autodescription/autodescription.php',
220
		),
221
		'verification-tools' => array(
222
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
223
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
224
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
225
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
226
			'The SEO Framework'              => 'autodescription/autodescription.php',
227
		),
228
		'widget-visibility'  => array(
229
			'Widget Logic'    => 'widget-logic/widget_logic.php',
230
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
231
		),
232
		'sitemaps'           => array(
233
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
234
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
235
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
236
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
237
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
238
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
239
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
240
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
241
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
242
			'The SEO Framework'                    => 'autodescription/autodescription.php',
243
			'Sitemap'                              => 'sitemap/sitemap.php',
244
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
245
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
246
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
247
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
248
		),
249
		'lazy-images'        => array(
250
			'Lazy Load'              => 'lazy-load/lazy-load.php',
251
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
252
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
253
		),
254
	);
255
256
	/**
257
	 * Plugins for which we turn off our Facebook OG Tags implementation.
258
	 *
259
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
260
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
261
	 *
262
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
263
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
264
	 */
265
	private $open_graph_conflicting_plugins = array(
266
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
267
		// 2 Click Social Media Buttons
268
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
269
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
270
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
271
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
272
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
273
		// Open Graph Meta Tags by Heateor
274
		'facebook/facebook.php',                                 // Facebook (official plugin)
275
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
276
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
277
		// Facebook Featured Image & OG Meta Tags
278
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
279
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
280
		// Facebook Open Graph Meta Tags for WordPress
281
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
282
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
283
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
284
		// Fedmich's Facebook Open Graph Meta
285
		'network-publisher/networkpub.php',                      // Network Publisher
286
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
287
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
288
		// NextScripts SNAP
289
		'og-tags/og-tags.php',                                   // OG Tags
290
		'opengraph/opengraph.php',                               // Open Graph
291
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
292
		// Open Graph Protocol Framework
293
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
294
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
295
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
296
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
297
		'sharepress/sharepress.php',                             // SharePress
298
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
299
		'social-discussions/social-discussions.php',             // Social Discussions
300
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
301
		'socialize/socialize.php',                               // Socialize
302
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
303
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
304
		// Tweet, Like, Google +1 and Share
305
		'wordbooker/wordbooker.php',                             // Wordbooker
306
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
307
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
308
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
309
		// WP Facebook Like Send & Open Graph Meta
310
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
311
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
312
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
313
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
314
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
315
	);
316
317
	/**
318
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
319
	 */
320
	private $twitter_cards_conflicting_plugins = array(
321
		// 'twitter/twitter.php',                       // The official one handles this on its own.
322
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
323
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
324
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
325
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
326
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
327
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
328
		'twitter-cards/twitter-cards.php',           // Twitter Cards
329
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
330
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
331
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
332
	);
333
334
	/**
335
	 * Message to display in admin_notice
336
	 *
337
	 * @var string
338
	 */
339
	public $message = '';
340
341
	/**
342
	 * Error to display in admin_notice
343
	 *
344
	 * @var string
345
	 */
346
	public $error = '';
347
348
	/**
349
	 * Modules that need more privacy description.
350
	 *
351
	 * @var string
352
	 */
353
	public $privacy_checks = '';
354
355
	/**
356
	 * Stats to record once the page loads
357
	 *
358
	 * @var array
359
	 */
360
	public $stats = array();
361
362
	/**
363
	 * Jetpack_Sync object
364
	 */
365
	public $sync;
366
367
	/**
368
	 * Verified data for JSON authorization request
369
	 */
370
	public $json_api_authorization_request = array();
371
372
	/**
373
	 * @var Automattic\Jetpack\Connection\Manager
374
	 */
375
	protected $connection_manager;
376
377
	/**
378
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
379
	 */
380
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
381
382
	/**
383
	 * Constant for login redirect key.
384
	 *
385
	 * @var string
386
	 * @since 8.4.0
387
	 */
388
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
389
390
	/**
391
	 * Holds the singleton instance of this class
392
	 *
393
	 * @since 2.3.3
394
	 * @var Jetpack
395
	 */
396
	static $instance = false;
397
398
	/**
399
	 * Singleton
400
	 *
401
	 * @static
402
	 */
403
	public static function init() {
404
		if ( ! self::$instance ) {
405
			self::$instance = new Jetpack();
406
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
407
		}
408
409
		return self::$instance;
410
	}
411
412
	/**
413
	 * Must never be called statically
414
	 */
415
	function plugin_upgrade() {
416
		if ( self::is_active() ) {
417
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
418
			if ( JETPACK__VERSION != $version ) {
419
				// Prevent multiple upgrades at once - only a single process should trigger
420
				// an upgrade to avoid stampedes
421
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
422
					return;
423
				}
424
425
				// Set a short lock to prevent multiple instances of the upgrade
426
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
427
428
				// check which active modules actually exist and remove others from active_modules list
429
				$unfiltered_modules = self::get_active_modules();
430
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
431
				if ( array_diff( $unfiltered_modules, $modules ) ) {
432
					self::update_active_modules( $modules );
433
				}
434
435
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
436
437
				// Upgrade to 4.3.0
438
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
439
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
440
				}
441
442
				// Make sure Markdown for posts gets turned back on
443
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
444
					update_option( 'wpcom_publish_posts_with_markdown', true );
445
				}
446
447
				/*
448
				 * Minileven deprecation. 8.3.0.
449
				 * Only delete options if not using
450
				 * the replacement standalone Minileven plugin.
451
				 */
452
				if (
453
					! self::is_plugin_active( 'minileven-master/minileven.php' )
454
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
455
				) {
456
					if ( get_option( 'wp_mobile_custom_css' ) ) {
457
						delete_option( 'wp_mobile_custom_css' );
458
					}
459
					if ( get_option( 'wp_mobile_excerpt' ) ) {
460
						delete_option( 'wp_mobile_excerpt' );
461
					}
462
					if ( get_option( 'wp_mobile_featured_images' ) ) {
463
						delete_option( 'wp_mobile_featured_images' );
464
					}
465
					if ( get_option( 'wp_mobile_app_promos' ) ) {
466
						delete_option( 'wp_mobile_app_promos' );
467
					}
468
				}
469
470
				// Upgrade to 8.4.0.
471
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
472
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
473
				}
474
475
				if ( did_action( 'wp_loaded' ) ) {
476
					self::upgrade_on_load();
477
				} else {
478
					add_action(
479
						'wp_loaded',
480
						array( __CLASS__, 'upgrade_on_load' )
481
					);
482
				}
483
			}
484
		}
485
	}
486
487
	/**
488
	 * Runs upgrade routines that need to have modules loaded.
489
	 */
490
	static function upgrade_on_load() {
491
492
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
493
		// This can happen in case Jetpack has been just upgraded and is
494
		// being initialized late during the page load. In this case we wait
495
		// until the next proper admin page load with Jetpack active.
496
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
497
			delete_transient( self::$plugin_upgrade_lock_key );
498
499
			return;
500
		}
501
502
		self::maybe_set_version_option();
503
504
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
505
			Jetpack_Widget_Conditions::migrate_post_type_rules();
506
		}
507
508
		if (
509
			class_exists( 'Jetpack_Sitemap_Manager' )
510
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
511
		) {
512
			do_action( 'jetpack_sitemaps_purge_data' );
513
		}
514
515
		// Delete old stats cache
516
		delete_option( 'jetpack_restapi_stats_cache' );
517
518
		delete_transient( self::$plugin_upgrade_lock_key );
519
	}
520
521
	/**
522
	 * Saves all the currently active modules to options.
523
	 * Also fires Action hooks for each newly activated and deactivated module.
524
	 *
525
	 * @param $modules Array Array of active modules to be saved in options.
526
	 *
527
	 * @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...
528
	 */
529
	static function update_active_modules( $modules ) {
530
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
531
		$active_modules       = self::get_active_modules();
532
		$new_active_modules   = array_diff( $modules, $current_modules );
533
		$new_inactive_modules = array_diff( $active_modules, $modules );
534
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
535
		$reindexed_modules    = array_values( $new_current_modules );
536
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
537
538
		foreach ( $new_active_modules as $module ) {
539
			/**
540
			 * Fires when a specific module is activated.
541
			 *
542
			 * @since 1.9.0
543
			 *
544
			 * @param string $module Module slug.
545
			 * @param boolean $success whether the module was activated. @since 4.2
546
			 */
547
			do_action( 'jetpack_activate_module', $module, $success );
548
			/**
549
			 * Fires when a module is activated.
550
			 * The dynamic part of the filter, $module, is the module slug.
551
			 *
552
			 * @since 1.9.0
553
			 *
554
			 * @param string $module Module slug.
555
			 */
556
			do_action( "jetpack_activate_module_$module", $module );
557
		}
558
559
		foreach ( $new_inactive_modules as $module ) {
560
			/**
561
			 * Fired after a module has been deactivated.
562
			 *
563
			 * @since 4.2.0
564
			 *
565
			 * @param string $module Module slug.
566
			 * @param boolean $success whether the module was deactivated.
567
			 */
568
			do_action( 'jetpack_deactivate_module', $module, $success );
569
			/**
570
			 * Fires when a module is deactivated.
571
			 * The dynamic part of the filter, $module, is the module slug.
572
			 *
573
			 * @since 1.9.0
574
			 *
575
			 * @param string $module Module slug.
576
			 */
577
			do_action( "jetpack_deactivate_module_$module", $module );
578
		}
579
580
		return $success;
581
	}
582
583
	static function delete_active_modules() {
584
		self::update_active_modules( array() );
585
	}
586
587
	/**
588
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
589
	 * available.
590
	 */
591
	public function add_configure_hook() {
592
		global $wp_filter;
593
594
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
595
		if ( false !== $current_priority ) {
596
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
597
		}
598
599
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
600
		sort( $taken_priorities );
601
602
		$first_priority = array_shift( $taken_priorities );
603
604
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
605
			$new_priority = - PHP_INT_MAX;
606
		} else {
607
			$new_priority = $first_priority - 1;
608
		}
609
610
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
611
	}
612
613
	/**
614
	 * Constructor.  Initializes WordPress hooks
615
	 */
616
	private function __construct() {
617
		/*
618
		 * Check for and alert any deprecated hooks
619
		 */
620
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
621
622
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
623
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
624
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
625
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
626
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
627
628
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
629
630
		add_filter(
631
			'jetpack_signature_check_token',
632
			array( __CLASS__, 'verify_onboarding_token' ),
633
			10,
634
			3
635
		);
636
637
		/**
638
		 * Prepare Gutenberg Editor functionality
639
		 */
640
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
641
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
642
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
643
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
644
645
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
646
647
		// Unlink user before deleting the user from WP.com.
648
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
649
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
650
651
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
652
653
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
654
		add_action( 'login_init', array( $this, 'login_init' ) );
655
656
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
657
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
658
659
		add_action( 'admin_init', array( $this, 'admin_init' ) );
660
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
661
662
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
663
664
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
665
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
666
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
667
668
		// returns HTTPS support status
669
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
670
671
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
672
673
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
674
675
		/**
676
		 * These actions run checks to load additional files.
677
		 * They check for external files or plugins, so they need to run as late as possible.
678
		 */
679
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
680
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
681
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
682
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
683
684
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
685
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
686
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
687
688
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
689
690
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
691
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
692
693
		// A filter to control all just in time messages
694
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
695
696
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
697
698
		/*
699
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
700
		 * We should make sure to only do this for front end links.
701
		 */
702
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
703
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
704
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
705
706
			/*
707
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
708
			 * so they point moderation links on emails to Calypso.
709
			 */
710
			jetpack_require_lib( 'functions.wp-notify' );
711
		}
712
713
		// Hide edit post link if mobile app.
714
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
715
			add_filter( 'get_edit_post_link', '__return_empty_string' );
716
		}
717
718
		// Update the Jetpack plan from API on heartbeats.
719
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
720
721
		/**
722
		 * This is the hack to concatenate all css files into one.
723
		 * For description and reasoning see the implode_frontend_css method.
724
		 *
725
		 * Super late priority so we catch all the registered styles.
726
		 */
727
		if ( ! is_admin() ) {
728
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
729
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
730
		}
731
732
		/**
733
		 * These are sync actions that we need to keep track of for jitms
734
		 */
735
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
736
737
		// Actually push the stats on shutdown.
738
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
739
			add_action( 'shutdown', array( $this, 'push_stats' ) );
740
		}
741
742
		/*
743
		 * Load some scripts asynchronously.
744
		 */
745
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
746
747
		// Actions for Manager::authorize().
748
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
749
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
750
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
751
752
		// Filters for the Manager::get_token() urls and request body.
753
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
754
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
755
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
756
	}
757
758
	/**
759
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
760
	 * Config object.
761
	 */
762
	public function configure() {
763
		$config = new Config();
764
765
		foreach (
766
			array(
767
				'connection',
768
				'sync',
769
				'tracking',
770
				'tos',
771
			)
772
			as $feature
773
		) {
774
			$config->ensure( $feature );
775
		}
776
777
		if ( is_admin() ) {
778
			$config->ensure( 'jitm' );
779
		}
780
781
		if ( ! $this->connection_manager ) {
782
			$this->connection_manager = new Connection_Manager();
783
		}
784
785
		/*
786
		 * Load things that should only be in Network Admin.
787
		 *
788
		 * For now blow away everything else until a more full
789
		 * understanding of what is needed at the network level is
790
		 * available
791
		 */
792
		if ( is_multisite() ) {
793
			$network = Jetpack_Network::init();
794
			$network->set_connection( $this->connection_manager );
795
		}
796
797
		if ( $this->connection_manager->is_active() ) {
798
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
799
800
			Jetpack_Heartbeat::init();
801
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
802
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
803
				Jetpack_Search_Performance_Logger::init();
804
			}
805
		}
806
807
		// Initialize remote file upload request handlers.
808
		$this->add_remote_request_handlers();
809
810
		/*
811
		 * Enable enhanced handling of previewing sites in Calypso
812
		 */
813
		if ( self::is_active() ) {
814
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
815
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
816
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
817
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
818
		}
819
	}
820
821
	/**
822
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
823
	 * initialization code.
824
	 *
825
	 * @action plugins_loaded
826
	 */
827
	public function late_initialization() {
828
		add_action( 'plugins_loaded', array( 'Jetpack', 'plugin_textdomain' ), 99 );
829
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
830
831
		Partner::init();
832
833
		/**
834
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
835
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
836
		 *
837
		 * @since 8.1.0
838
		 *
839
		 * @param Jetpack $jetpack the main plugin class object.
840
		 */
841
		do_action( 'jetpack_loaded', $this );
842
843
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
844
	}
845
846
	/**
847
	 * Sets up the XMLRPC request handlers.
848
	 *
849
	 * @deprecated since 7.7.0
850
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
851
	 *
852
	 * @param Array                 $request_params Incoming request parameters.
853
	 * @param Boolean               $is_active      Whether the connection is currently active.
854
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
855
	 * @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...
856
	 */
857 View Code Duplication
	public function setup_xmlrpc_handlers(
858
		$request_params,
859
		$is_active,
860
		$is_signed,
861
		Jetpack_XMLRPC_Server $xmlrpc_server = null
862
	) {
863
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
864
865
		if ( ! $this->connection_manager ) {
866
			$this->connection_manager = new Connection_Manager();
867
		}
868
869
		return $this->connection_manager->setup_xmlrpc_handlers(
870
			$request_params,
871
			$is_active,
872
			$is_signed,
873
			$xmlrpc_server
874
		);
875
	}
876
877
	/**
878
	 * Initialize REST API registration connector.
879
	 *
880
	 * @deprecated since 7.7.0
881
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
882
	 */
883 View Code Duplication
	public function initialize_rest_api_registration_connector() {
884
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
885
886
		if ( ! $this->connection_manager ) {
887
			$this->connection_manager = new Connection_Manager();
888
		}
889
890
		$this->connection_manager->initialize_rest_api_registration_connector();
891
	}
892
893
	/**
894
	 * This is ported over from the manage module, which has been deprecated and baked in here.
895
	 *
896
	 * @param $domains
897
	 */
898
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
899
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
900
	}
901
902
	/**
903
	 * Return $domains, with 'wordpress.com' appended.
904
	 * This is ported over from the manage module, which has been deprecated and baked in here.
905
	 *
906
	 * @param $domains
907
	 * @return array
908
	 */
909
	function allow_wpcom_domain( $domains ) {
910
		if ( empty( $domains ) ) {
911
			$domains = array();
912
		}
913
		$domains[] = 'wordpress.com';
914
		return array_unique( $domains );
915
	}
916
917
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
918
		$post = get_post( $post_id );
919
920
		if ( empty( $post ) ) {
921
			return $default_url;
922
		}
923
924
		$post_type = $post->post_type;
925
926
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
927
		// https://en.support.wordpress.com/custom-post-types/
928
		$allowed_post_types = array(
929
			'post',
930
			'page',
931
			'jetpack-portfolio',
932
			'jetpack-testimonial',
933
		);
934
935
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
936
			return $default_url;
937
		}
938
939
		return esc_url(
940
			Redirect::get_url(
941
				'calypso-edit-' . $post_type,
942
				array(
943
					'path' => $post_id,
944
				)
945
			)
946
		);
947
	}
948
949
	function point_edit_comment_links_to_calypso( $url ) {
950
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
951
		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...
952
953
		return esc_url(
954
			Redirect::get_url(
955
				'calypso-edit-comment',
956
				array(
957
					'path' => $query_args['amp;c'],
958
				)
959
			)
960
		);
961
962
	}
963
964
	function jetpack_track_last_sync_callback( $params ) {
965
		/**
966
		 * Filter to turn off jitm caching
967
		 *
968
		 * @since 5.4.0
969
		 *
970
		 * @param bool false Whether to cache just in time messages
971
		 */
972
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
973
			return $params;
974
		}
975
976
		if ( is_array( $params ) && isset( $params[0] ) ) {
977
			$option = $params[0];
978
			if ( 'active_plugins' === $option ) {
979
				// use the cache if we can, but not terribly important if it gets evicted
980
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
981
			}
982
		}
983
984
		return $params;
985
	}
986
987
	function jetpack_connection_banner_callback() {
988
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
989
990
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
991
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
992
			wp_send_json_success();
993
		}
994
995
		wp_die();
996
	}
997
998
	/**
999
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1000
	 * Only used in our alternate XML-RPC endpoint, where we want to
1001
	 * ensure that Core and other plugins' methods are not exposed.
1002
	 *
1003
	 * @deprecated since 7.7.0
1004
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1005
	 *
1006
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1007
	 * @return array Filtered $methods
1008
	 */
1009 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1010
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1011
1012
		if ( ! $this->connection_manager ) {
1013
			$this->connection_manager = new Connection_Manager();
1014
		}
1015
1016
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1017
	}
1018
1019
	/**
1020
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1021
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1022
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1023
	 * which is accessible via a different URI. Most of the below is copied directly
1024
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1025
	 *
1026
	 * @deprecated since 7.7.0
1027
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1028
	 */
1029 View Code Duplication
	public function alternate_xmlrpc() {
1030
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1031
1032
		if ( ! $this->connection_manager ) {
1033
			$this->connection_manager = new Connection_Manager();
1034
		}
1035
1036
		$this->connection_manager->alternate_xmlrpc();
1037
	}
1038
1039
	/**
1040
	 * The callback for the JITM ajax requests.
1041
	 *
1042
	 * @deprecated since 7.9.0
1043
	 */
1044
	function jetpack_jitm_ajax_callback() {
1045
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1046
	}
1047
1048
	/**
1049
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1050
	 */
1051
	function push_stats() {
1052
		if ( ! empty( $this->stats ) ) {
1053
			$this->do_stats( 'server_side' );
1054
		}
1055
	}
1056
1057
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1058
		$is_development_mode = ( new Status() )->is_development_mode();
1059
		switch ( $cap ) {
1060
			case 'jetpack_connect':
1061
			case 'jetpack_reconnect':
1062
				if ( $is_development_mode ) {
1063
					$caps = array( 'do_not_allow' );
1064
					break;
1065
				}
1066
				/**
1067
				 * Pass through. If it's not development mode, these should match disconnect.
1068
				 * Let users disconnect if it's development mode, just in case things glitch.
1069
				 */
1070
			case 'jetpack_disconnect':
1071
				/**
1072
				 * In multisite, can individual site admins manage their own connection?
1073
				 *
1074
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
1075
				 */
1076
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
1077
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
1078
						/**
1079
						 * We need to update the option name -- it's terribly unclear which
1080
						 * direction the override goes.
1081
						 *
1082
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
1083
						 */
1084
						$caps = array( 'do_not_allow' );
1085
						break;
1086
					}
1087
				}
1088
1089
				$caps = array( 'manage_options' );
1090
				break;
1091
			case 'jetpack_manage_modules':
1092
			case 'jetpack_activate_modules':
1093
			case 'jetpack_deactivate_modules':
1094
				$caps = array( 'manage_options' );
1095
				break;
1096
			case 'jetpack_configure_modules':
1097
				$caps = array( 'manage_options' );
1098
				break;
1099
			case 'jetpack_manage_autoupdates':
1100
				$caps = array(
1101
					'manage_options',
1102
					'update_plugins',
1103
				);
1104
				break;
1105
			case 'jetpack_network_admin_page':
1106
			case 'jetpack_network_settings_page':
1107
				$caps = array( 'manage_network_plugins' );
1108
				break;
1109
			case 'jetpack_network_sites_page':
1110
				$caps = array( 'manage_sites' );
1111
				break;
1112
			case 'jetpack_admin_page':
1113
				if ( $is_development_mode ) {
1114
					$caps = array( 'manage_options' );
1115
					break;
1116
				} else {
1117
					$caps = array( 'read' );
1118
				}
1119
				break;
1120
			case 'jetpack_connect_user':
1121
				if ( $is_development_mode ) {
1122
					$caps = array( 'do_not_allow' );
1123
					break;
1124
				}
1125
				$caps = array( 'read' );
1126
				break;
1127
		}
1128
		return $caps;
1129
	}
1130
1131
	/**
1132
	 * Require a Jetpack authentication.
1133
	 *
1134
	 * @deprecated since 7.7.0
1135
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1136
	 */
1137 View Code Duplication
	public function require_jetpack_authentication() {
1138
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1139
1140
		if ( ! $this->connection_manager ) {
1141
			$this->connection_manager = new Connection_Manager();
1142
		}
1143
1144
		$this->connection_manager->require_jetpack_authentication();
1145
	}
1146
1147
	/**
1148
	 * Load language files
1149
	 *
1150
	 * @action plugins_loaded
1151
	 */
1152
	public static function plugin_textdomain() {
1153
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1154
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1155
	}
1156
1157
	/**
1158
	 * Register assets for use in various modules and the Jetpack admin page.
1159
	 *
1160
	 * @uses wp_script_is, wp_register_script, plugins_url
1161
	 * @action wp_loaded
1162
	 * @return null
1163
	 */
1164
	public function register_assets() {
1165
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1166
			wp_register_script(
1167
				'spin',
1168
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1169
				false,
1170
				'1.3'
1171
			);
1172
		}
1173
1174 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1175
			wp_register_script(
1176
				'jquery.spin',
1177
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1178
				array( 'jquery', 'spin' ),
1179
				'1.3'
1180
			);
1181
		}
1182
1183 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1184
			wp_register_script(
1185
				'jetpack-gallery-settings',
1186
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1187
				array( 'media-views' ),
1188
				'20121225'
1189
			);
1190
		}
1191
1192 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1193
			wp_register_script(
1194
				'jetpack-twitter-timeline',
1195
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1196
				array( 'jquery' ),
1197
				'4.0.0',
1198
				true
1199
			);
1200
		}
1201
1202
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1203
			wp_register_script(
1204
				'jetpack-facebook-embed',
1205
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1206
				array(),
1207
				null,
1208
				true
1209
			);
1210
1211
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1212
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1213
			if ( ! is_numeric( $fb_app_id ) ) {
1214
				$fb_app_id = '';
1215
			}
1216
			wp_localize_script(
1217
				'jetpack-facebook-embed',
1218
				'jpfbembed',
1219
				array(
1220
					'appid'  => $fb_app_id,
1221
					'locale' => $this->get_locale(),
1222
				)
1223
			);
1224
		}
1225
1226
		/**
1227
		 * As jetpack_register_genericons is by default fired off a hook,
1228
		 * the hook may have already fired by this point.
1229
		 * So, let's just trigger it manually.
1230
		 */
1231
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1232
		jetpack_register_genericons();
1233
1234
		/**
1235
		 * Register the social logos
1236
		 */
1237
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1238
		jetpack_register_social_logos();
1239
1240 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1241
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1242
		}
1243
	}
1244
1245
	/**
1246
	 * Guess locale from language code.
1247
	 *
1248
	 * @param string $lang Language code.
1249
	 * @return string|bool
1250
	 */
1251 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1252
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1253
			return 'en_US';
1254
		}
1255
1256
		if ( ! class_exists( 'GP_Locales' ) ) {
1257
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1258
				return false;
1259
			}
1260
1261
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1262
		}
1263
1264
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1265
			// WP.com: get_locale() returns 'it'
1266
			$locale = GP_Locales::by_slug( $lang );
1267
		} else {
1268
			// Jetpack: get_locale() returns 'it_IT';
1269
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1270
		}
1271
1272
		if ( ! $locale ) {
1273
			return false;
1274
		}
1275
1276
		if ( empty( $locale->facebook_locale ) ) {
1277
			if ( empty( $locale->wp_locale ) ) {
1278
				return false;
1279
			} else {
1280
				// Facebook SDK is smart enough to fall back to en_US if a
1281
				// locale isn't supported. Since supported Facebook locales
1282
				// can fall out of sync, we'll attempt to use the known
1283
				// wp_locale value and rely on said fallback.
1284
				return $locale->wp_locale;
1285
			}
1286
		}
1287
1288
		return $locale->facebook_locale;
1289
	}
1290
1291
	/**
1292
	 * Get the locale.
1293
	 *
1294
	 * @return string|bool
1295
	 */
1296
	function get_locale() {
1297
		$locale = $this->guess_locale_from_lang( get_locale() );
1298
1299
		if ( ! $locale ) {
1300
			$locale = 'en_US';
1301
		}
1302
1303
		return $locale;
1304
	}
1305
1306
	/**
1307
	 * Return the network_site_url so that .com knows what network this site is a part of.
1308
	 *
1309
	 * @param  bool $option
1310
	 * @return string
1311
	 */
1312
	public function jetpack_main_network_site_option( $option ) {
1313
		return network_site_url();
1314
	}
1315
	/**
1316
	 * Network Name.
1317
	 */
1318
	static function network_name( $option = null ) {
1319
		global $current_site;
1320
		return $current_site->site_name;
1321
	}
1322
	/**
1323
	 * Does the network allow new user and site registrations.
1324
	 *
1325
	 * @return string
1326
	 */
1327
	static function network_allow_new_registrations( $option = null ) {
1328
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1329
	}
1330
	/**
1331
	 * Does the network allow admins to add new users.
1332
	 *
1333
	 * @return boolian
1334
	 */
1335
	static function network_add_new_users( $option = null ) {
1336
		return (bool) get_site_option( 'add_new_users' );
1337
	}
1338
	/**
1339
	 * File upload psace left per site in MB.
1340
	 *  -1 means NO LIMIT.
1341
	 *
1342
	 * @return number
1343
	 */
1344
	static function network_site_upload_space( $option = null ) {
1345
		// value in MB
1346
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1347
	}
1348
1349
	/**
1350
	 * Network allowed file types.
1351
	 *
1352
	 * @return string
1353
	 */
1354
	static function network_upload_file_types( $option = null ) {
1355
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1356
	}
1357
1358
	/**
1359
	 * Maximum file upload size set by the network.
1360
	 *
1361
	 * @return number
1362
	 */
1363
	static function network_max_upload_file_size( $option = null ) {
1364
		// value in KB
1365
		return get_site_option( 'fileupload_maxk', 300 );
1366
	}
1367
1368
	/**
1369
	 * Lets us know if a site allows admins to manage the network.
1370
	 *
1371
	 * @return array
1372
	 */
1373
	static function network_enable_administration_menus( $option = null ) {
1374
		return get_site_option( 'menu_items' );
1375
	}
1376
1377
	/**
1378
	 * If a user has been promoted to or demoted from admin, we need to clear the
1379
	 * jetpack_other_linked_admins transient.
1380
	 *
1381
	 * @since 4.3.2
1382
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1383
	 *
1384
	 * @param int    $user_id   The user ID whose role changed.
1385
	 * @param string $role      The new role.
1386
	 * @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...
1387
	 */
1388
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1389
		if ( 'administrator' == $role
1390
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1391
			|| is_null( $old_roles )
1392
		) {
1393
			delete_transient( 'jetpack_other_linked_admins' );
1394
		}
1395
	}
1396
1397
	/**
1398
	 * Checks to see if there are any other users available to become primary
1399
	 * Users must both:
1400
	 * - Be linked to wpcom
1401
	 * - Be an admin
1402
	 *
1403
	 * @return mixed False if no other users are linked, Int if there are.
1404
	 */
1405
	static function get_other_linked_admins() {
1406
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1407
1408
		if ( false === $other_linked_users ) {
1409
			$admins = get_users( array( 'role' => 'administrator' ) );
1410
			if ( count( $admins ) > 1 ) {
1411
				$available = array();
1412
				foreach ( $admins as $admin ) {
1413
					if ( self::is_user_connected( $admin->ID ) ) {
1414
						$available[] = $admin->ID;
1415
					}
1416
				}
1417
1418
				$count_connected_admins = count( $available );
1419
				if ( count( $available ) > 1 ) {
1420
					$other_linked_users = $count_connected_admins;
1421
				} else {
1422
					$other_linked_users = 0;
1423
				}
1424
			} else {
1425
				$other_linked_users = 0;
1426
			}
1427
1428
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1429
		}
1430
1431
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1432
	}
1433
1434
	/**
1435
	 * Return whether we are dealing with a multi network setup or not.
1436
	 * The reason we are type casting this is because we want to avoid the situation where
1437
	 * the result is false since when is_main_network_option return false it cases
1438
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1439
	 * database which could be set to anything as opposed to what this function returns.
1440
	 *
1441
	 * @param  bool $option
1442
	 *
1443
	 * @return boolean
1444
	 */
1445
	public function is_main_network_option( $option ) {
1446
		// return '1' or ''
1447
		return (string) (bool) self::is_multi_network();
1448
	}
1449
1450
	/**
1451
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1452
	 *
1453
	 * @param  string $option
1454
	 * @return boolean
1455
	 */
1456
	public function is_multisite( $option ) {
1457
		return (string) (bool) is_multisite();
1458
	}
1459
1460
	/**
1461
	 * Implemented since there is no core is multi network function
1462
	 * Right now there is no way to tell if we which network is the dominant network on the system
1463
	 *
1464
	 * @since  3.3
1465
	 * @return boolean
1466
	 */
1467 View Code Duplication
	public static function is_multi_network() {
1468
		global  $wpdb;
1469
1470
		// if we don't have a multi site setup no need to do any more
1471
		if ( ! is_multisite() ) {
1472
			return false;
1473
		}
1474
1475
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1476
		if ( $num_sites > 1 ) {
1477
			return true;
1478
		} else {
1479
			return false;
1480
		}
1481
	}
1482
1483
	/**
1484
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1485
	 *
1486
	 * @return null
1487
	 */
1488
	function update_jetpack_main_network_site_option() {
1489
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1490
	}
1491
	/**
1492
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1493
	 */
1494
	function update_jetpack_network_settings() {
1495
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1496
		// Only sync this info for the main network site.
1497
	}
1498
1499
	/**
1500
	 * Get back if the current site is single user site.
1501
	 *
1502
	 * @return bool
1503
	 */
1504 View Code Duplication
	public static function is_single_user_site() {
1505
		global $wpdb;
1506
1507
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1508
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1509
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1510
		}
1511
		return 1 === (int) $some_users;
1512
	}
1513
1514
	/**
1515
	 * Returns true if the site has file write access false otherwise.
1516
	 *
1517
	 * @return string ( '1' | '0' )
1518
	 **/
1519
	public static function file_system_write_access() {
1520
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1521
			require_once ABSPATH . 'wp-admin/includes/file.php';
1522
		}
1523
1524
		require_once ABSPATH . 'wp-admin/includes/template.php';
1525
1526
		$filesystem_method = get_filesystem_method();
1527
		if ( $filesystem_method === 'direct' ) {
1528
			return 1;
1529
		}
1530
1531
		ob_start();
1532
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1533
		ob_end_clean();
1534
		if ( $filesystem_credentials_are_stored ) {
1535
			return 1;
1536
		}
1537
		return 0;
1538
	}
1539
1540
	/**
1541
	 * Finds out if a site is using a version control system.
1542
	 *
1543
	 * @return string ( '1' | '0' )
1544
	 **/
1545
	public static function is_version_controlled() {
1546
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1547
		return (string) (int) Functions::is_version_controlled();
1548
	}
1549
1550
	/**
1551
	 * Determines whether the current theme supports featured images or not.
1552
	 *
1553
	 * @return string ( '1' | '0' )
1554
	 */
1555
	public static function featured_images_enabled() {
1556
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1557
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1558
	}
1559
1560
	/**
1561
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1562
	 *
1563
	 * @deprecated 4.7 use get_avatar_url instead.
1564
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1565
	 * @param int               $size Size of the avatar image
1566
	 * @param string            $default URL to a default image to use if no avatar is available
1567
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1568
	 *
1569
	 * @return array
1570
	 */
1571
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1572
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1573
		return get_avatar_url(
1574
			$id_or_email,
1575
			array(
1576
				'size'          => $size,
1577
				'default'       => $default,
1578
				'force_default' => $force_display,
1579
			)
1580
		);
1581
	}
1582
1583
	/**
1584
	 * jetpack_updates is saved in the following schema:
1585
	 *
1586
	 * array (
1587
	 *      'plugins'                       => (int) Number of plugin updates available.
1588
	 *      'themes'                        => (int) Number of theme updates available.
1589
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1590
	 *      'translations'                  => (int) Number of translation updates available.
1591
	 *      'total'                         => (int) Total of all available updates.
1592
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1593
	 * )
1594
	 *
1595
	 * @return array
1596
	 */
1597
	public static function get_updates() {
1598
		$update_data = wp_get_update_data();
1599
1600
		// Stores the individual update counts as well as the total count.
1601
		if ( isset( $update_data['counts'] ) ) {
1602
			$updates = $update_data['counts'];
1603
		}
1604
1605
		// If we need to update WordPress core, let's find the latest version number.
1606 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1607
			$cur = get_preferred_from_update_core();
1608
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1609
				$updates['wp_update_version'] = $cur->current;
1610
			}
1611
		}
1612
		return isset( $updates ) ? $updates : array();
1613
	}
1614
1615
	public static function get_update_details() {
1616
		$update_details = array(
1617
			'update_core'    => get_site_transient( 'update_core' ),
1618
			'update_plugins' => get_site_transient( 'update_plugins' ),
1619
			'update_themes'  => get_site_transient( 'update_themes' ),
1620
		);
1621
		return $update_details;
1622
	}
1623
1624
	public static function refresh_update_data() {
1625
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1626
1627
	}
1628
1629
	public static function refresh_theme_data() {
1630
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1631
	}
1632
1633
	/**
1634
	 * Is Jetpack active?
1635
	 */
1636
	public static function is_active() {
1637
		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...
1638
	}
1639
1640
	/**
1641
	 * Make an API call to WordPress.com for plan status
1642
	 *
1643
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1644
	 *
1645
	 * @return bool True if plan is updated, false if no update
1646
	 */
1647
	public static function refresh_active_plan_from_wpcom() {
1648
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1649
		return Jetpack_Plan::refresh_from_wpcom();
1650
	}
1651
1652
	/**
1653
	 * Get the plan that this Jetpack site is currently using
1654
	 *
1655
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1656
	 * @return array Active Jetpack plan details.
1657
	 */
1658
	public static function get_active_plan() {
1659
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1660
		return Jetpack_Plan::get();
1661
	}
1662
1663
	/**
1664
	 * Determine whether the active plan supports a particular feature
1665
	 *
1666
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1667
	 * @return bool True if plan supports feature, false if not.
1668
	 */
1669
	public static function active_plan_supports( $feature ) {
1670
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1671
		return Jetpack_Plan::supports( $feature );
1672
	}
1673
1674
	/**
1675
	 * Deprecated: Is Jetpack in development (offline) mode?
1676
	 *
1677
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1678
	 * and themes still use it, and we do not want to flood them with notices.
1679
	 *
1680
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1681
	 *
1682
	 * @deprecated since 8.0.
1683
	 */
1684
	public static function is_development_mode() {
1685
		return ( new Status() )->is_development_mode();
1686
	}
1687
1688
	/**
1689
	 * Whether the site is currently onboarding or not.
1690
	 * A site is considered as being onboarded if it currently has an onboarding token.
1691
	 *
1692
	 * @since 5.8
1693
	 *
1694
	 * @access public
1695
	 * @static
1696
	 *
1697
	 * @return bool True if the site is currently onboarding, false otherwise
1698
	 */
1699
	public static function is_onboarding() {
1700
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1701
	}
1702
1703
	/**
1704
	 * Determines reason for Jetpack development mode.
1705
	 */
1706
	public static function development_mode_trigger_text() {
1707
		if ( ! ( new Status() )->is_development_mode() ) {
1708
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1709
		}
1710
1711
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1712
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1713
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1714
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1715
		} else {
1716
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1717
		}
1718
1719
		return $notice;
1720
1721
	}
1722
	/**
1723
	 * Get Jetpack development mode notice text and notice class.
1724
	 *
1725
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1726
	 */
1727
	public static function show_development_mode_notice() {
1728 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1729
			$notice = sprintf(
1730
				/* translators: %s is a URL */
1731
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1732
				Redirect::get_url( 'jetpack-support-development-mode' )
1733
			);
1734
1735
			$notice .= ' ' . self::development_mode_trigger_text();
1736
1737
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1738
		}
1739
1740
		// Throw up a notice if using a development version and as for feedback.
1741
		if ( self::is_development_version() ) {
1742
			/* translators: %s is a URL */
1743
			$notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), Redirect::get_url( 'jetpack-contact-support-beta-group' ) );
1744
1745
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1746
		}
1747
		// Throw up a notice if using staging mode
1748 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1749
			/* translators: %s is a URL */
1750
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1751
1752
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1753
		}
1754
	}
1755
1756
	/**
1757
	 * Whether Jetpack's version maps to a public release, or a development version.
1758
	 */
1759
	public static function is_development_version() {
1760
		/**
1761
		 * Allows filtering whether this is a development version of Jetpack.
1762
		 *
1763
		 * This filter is especially useful for tests.
1764
		 *
1765
		 * @since 4.3.0
1766
		 *
1767
		 * @param bool $development_version Is this a develoment version of Jetpack?
1768
		 */
1769
		return (bool) apply_filters(
1770
			'jetpack_development_version',
1771
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1772
		);
1773
	}
1774
1775
	/**
1776
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1777
	 */
1778
	public static function is_user_connected( $user_id = false ) {
1779
		return self::connection()->is_user_connected( $user_id );
1780
	}
1781
1782
	/**
1783
	 * Get the wpcom user data of the current|specified connected user.
1784
	 */
1785 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1786
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1787
		if ( ! $user_id ) {
1788
			$user_id = get_current_user_id();
1789
		}
1790
1791
		$transient_key = "jetpack_connected_user_data_$user_id";
1792
1793
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1794
			return $cached_user_data;
1795
		}
1796
1797
		$xml = new Jetpack_IXR_Client(
1798
			array(
1799
				'user_id' => $user_id,
1800
			)
1801
		);
1802
		$xml->query( 'wpcom.getUser' );
1803
		if ( ! $xml->isError() ) {
1804
			$user_data = $xml->getResponse();
1805
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1806
			return $user_data;
1807
		}
1808
1809
		return false;
1810
	}
1811
1812
	/**
1813
	 * Get the wpcom email of the current|specified connected user.
1814
	 */
1815
	public static function get_connected_user_email( $user_id = null ) {
1816
		if ( ! $user_id ) {
1817
			$user_id = get_current_user_id();
1818
		}
1819
1820
		$xml = new Jetpack_IXR_Client(
1821
			array(
1822
				'user_id' => $user_id,
1823
			)
1824
		);
1825
		$xml->query( 'wpcom.getUserEmail' );
1826
		if ( ! $xml->isError() ) {
1827
			return $xml->getResponse();
1828
		}
1829
		return false;
1830
	}
1831
1832
	/**
1833
	 * Get the wpcom email of the master user.
1834
	 */
1835
	public static function get_master_user_email() {
1836
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1837
		if ( $master_user_id ) {
1838
			return self::get_connected_user_email( $master_user_id );
1839
		}
1840
		return '';
1841
	}
1842
1843
	/**
1844
	 * Whether the current user is the connection owner.
1845
	 *
1846
	 * @deprecated since 7.7
1847
	 *
1848
	 * @return bool Whether the current user is the connection owner.
1849
	 */
1850
	public function current_user_is_connection_owner() {
1851
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1852
		return self::connection()->is_connection_owner();
1853
	}
1854
1855
	/**
1856
	 * Gets current user IP address.
1857
	 *
1858
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1859
	 *
1860
	 * @return string                  Current user IP address.
1861
	 */
1862
	public static function current_user_ip( $check_all_headers = false ) {
1863
		if ( $check_all_headers ) {
1864
			foreach ( array(
1865
				'HTTP_CF_CONNECTING_IP',
1866
				'HTTP_CLIENT_IP',
1867
				'HTTP_X_FORWARDED_FOR',
1868
				'HTTP_X_FORWARDED',
1869
				'HTTP_X_CLUSTER_CLIENT_IP',
1870
				'HTTP_FORWARDED_FOR',
1871
				'HTTP_FORWARDED',
1872
				'HTTP_VIA',
1873
			) as $key ) {
1874
				if ( ! empty( $_SERVER[ $key ] ) ) {
1875
					return $_SERVER[ $key ];
1876
				}
1877
			}
1878
		}
1879
1880
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1881
	}
1882
1883
	/**
1884
	 * Synchronize connected user role changes
1885
	 */
1886
	function user_role_change( $user_id ) {
1887
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1888
		Users::user_role_change( $user_id );
1889
	}
1890
1891
	/**
1892
	 * Loads the currently active modules.
1893
	 */
1894
	public static function load_modules() {
1895
		$is_development_mode = ( new Status() )->is_development_mode();
1896
		if (
1897
			! self::is_active()
1898
			&& ! $is_development_mode
1899
			&& ! self::is_onboarding()
1900
			&& (
1901
				! is_multisite()
1902
				|| ! get_site_option( 'jetpack_protect_active' )
1903
			)
1904
		) {
1905
			return;
1906
		}
1907
1908
		$version = Jetpack_Options::get_option( 'version' );
1909 View Code Duplication
		if ( ! $version ) {
1910
			$version = $old_version = JETPACK__VERSION . ':' . time();
1911
			/** This action is documented in class.jetpack.php */
1912
			do_action( 'updating_jetpack_version', $version, false );
1913
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1914
		}
1915
		list( $version ) = explode( ':', $version );
1916
1917
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1918
1919
		$modules_data = array();
1920
1921
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1922
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1923
			$updated_modules = array();
1924
			foreach ( $modules as $module ) {
1925
				$modules_data[ $module ] = self::get_module( $module );
1926
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1927
					continue;
1928
				}
1929
1930
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1931
					continue;
1932
				}
1933
1934
				$updated_modules[] = $module;
1935
			}
1936
1937
			$modules = array_diff( $modules, $updated_modules );
1938
		}
1939
1940
		foreach ( $modules as $index => $module ) {
1941
			// If we're in dev mode, disable modules requiring a connection
1942
			if ( $is_development_mode ) {
1943
				// Prime the pump if we need to
1944
				if ( empty( $modules_data[ $module ] ) ) {
1945
					$modules_data[ $module ] = self::get_module( $module );
1946
				}
1947
				// If the module requires a connection, but we're in local mode, don't include it.
1948
				if ( $modules_data[ $module ]['requires_connection'] ) {
1949
					continue;
1950
				}
1951
			}
1952
1953
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1954
				continue;
1955
			}
1956
1957
			if ( ! include_once self::get_module_path( $module ) ) {
1958
				unset( $modules[ $index ] );
1959
				self::update_active_modules( array_values( $modules ) );
1960
				continue;
1961
			}
1962
1963
			/**
1964
			 * Fires when a specific module is loaded.
1965
			 * The dynamic part of the hook, $module, is the module slug.
1966
			 *
1967
			 * @since 1.1.0
1968
			 */
1969
			do_action( 'jetpack_module_loaded_' . $module );
1970
		}
1971
1972
		/**
1973
		 * Fires when all the modules are loaded.
1974
		 *
1975
		 * @since 1.1.0
1976
		 */
1977
		do_action( 'jetpack_modules_loaded' );
1978
1979
		// 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.
1980
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1981
	}
1982
1983
	/**
1984
	 * Check if Jetpack's REST API compat file should be included
1985
	 *
1986
	 * @action plugins_loaded
1987
	 * @return null
1988
	 */
1989
	public function check_rest_api_compat() {
1990
		/**
1991
		 * Filters the list of REST API compat files to be included.
1992
		 *
1993
		 * @since 2.2.5
1994
		 *
1995
		 * @param array $args Array of REST API compat files to include.
1996
		 */
1997
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1998
1999
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
2000
			require_once $_jetpack_rest_api_compat_include;
2001
		}
2002
	}
2003
2004
	/**
2005
	 * Gets all plugins currently active in values, regardless of whether they're
2006
	 * traditionally activated or network activated.
2007
	 *
2008
	 * @todo Store the result in core's object cache maybe?
2009
	 */
2010
	public static function get_active_plugins() {
2011
		$active_plugins = (array) get_option( 'active_plugins', array() );
2012
2013
		if ( is_multisite() ) {
2014
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2015
			// whereas active_plugins stores them in the values.
2016
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2017
			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...
2018
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2019
			}
2020
		}
2021
2022
		sort( $active_plugins );
2023
2024
		return array_unique( $active_plugins );
2025
	}
2026
2027
	/**
2028
	 * Gets and parses additional plugin data to send with the heartbeat data
2029
	 *
2030
	 * @since 3.8.1
2031
	 *
2032
	 * @return array Array of plugin data
2033
	 */
2034
	public static function get_parsed_plugin_data() {
2035
		if ( ! function_exists( 'get_plugins' ) ) {
2036
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2037
		}
2038
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2039
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2040
		$active_plugins = self::get_active_plugins();
2041
2042
		$plugins = array();
2043
		foreach ( $all_plugins as $path => $plugin_data ) {
2044
			$plugins[ $path ] = array(
2045
				'is_active' => in_array( $path, $active_plugins ),
2046
				'file'      => $path,
2047
				'name'      => $plugin_data['Name'],
2048
				'version'   => $plugin_data['Version'],
2049
				'author'    => $plugin_data['Author'],
2050
			);
2051
		}
2052
2053
		return $plugins;
2054
	}
2055
2056
	/**
2057
	 * Gets and parses theme data to send with the heartbeat data
2058
	 *
2059
	 * @since 3.8.1
2060
	 *
2061
	 * @return array Array of theme data
2062
	 */
2063
	public static function get_parsed_theme_data() {
2064
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2065
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2066
2067
		$themes = array();
2068
		foreach ( $all_themes as $slug => $theme_data ) {
2069
			$theme_headers = array();
2070
			foreach ( $header_keys as $header_key ) {
2071
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2072
			}
2073
2074
			$themes[ $slug ] = array(
2075
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2076
				'slug'            => $slug,
2077
				'theme_root'      => $theme_data->get_theme_root_uri(),
2078
				'parent'          => $theme_data->parent(),
2079
				'headers'         => $theme_headers,
2080
			);
2081
		}
2082
2083
		return $themes;
2084
	}
2085
2086
	/**
2087
	 * Checks whether a specific plugin is active.
2088
	 *
2089
	 * We don't want to store these in a static variable, in case
2090
	 * there are switch_to_blog() calls involved.
2091
	 */
2092
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2093
		return in_array( $plugin, self::get_active_plugins() );
2094
	}
2095
2096
	/**
2097
	 * Check if Jetpack's Open Graph tags should be used.
2098
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2099
	 *
2100
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2101
	 * @action plugins_loaded
2102
	 * @return null
2103
	 */
2104
	public function check_open_graph() {
2105
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2106
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2107
		}
2108
2109
		$active_plugins = self::get_active_plugins();
2110
2111
		if ( ! empty( $active_plugins ) ) {
2112
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2113
				if ( in_array( $plugin, $active_plugins ) ) {
2114
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2115
					break;
2116
				}
2117
			}
2118
		}
2119
2120
		/**
2121
		 * Allow the addition of Open Graph Meta Tags to all pages.
2122
		 *
2123
		 * @since 2.0.3
2124
		 *
2125
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2126
		 */
2127
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2128
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2129
		}
2130
	}
2131
2132
	/**
2133
	 * Check if Jetpack's Twitter tags should be used.
2134
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2135
	 *
2136
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2137
	 * @action plugins_loaded
2138
	 * @return null
2139
	 */
2140
	public function check_twitter_tags() {
2141
2142
		$active_plugins = self::get_active_plugins();
2143
2144
		if ( ! empty( $active_plugins ) ) {
2145
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2146
				if ( in_array( $plugin, $active_plugins ) ) {
2147
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2148
					break;
2149
				}
2150
			}
2151
		}
2152
2153
		/**
2154
		 * Allow Twitter Card Meta tags to be disabled.
2155
		 *
2156
		 * @since 2.6.0
2157
		 *
2158
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2159
		 */
2160
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2161
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2162
		}
2163
	}
2164
2165
	/**
2166
	 * Allows plugins to submit security reports.
2167
	 *
2168
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2169
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2170
	 * @param array  $args         See definitions above
2171
	 */
2172
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2173
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2174
	}
2175
2176
	/* Jetpack Options API */
2177
2178
	public static function get_option_names( $type = 'compact' ) {
2179
		return Jetpack_Options::get_option_names( $type );
2180
	}
2181
2182
	/**
2183
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2184
	 *
2185
	 * @param string $name    Option name
2186
	 * @param mixed  $default (optional)
2187
	 */
2188
	public static function get_option( $name, $default = false ) {
2189
		return Jetpack_Options::get_option( $name, $default );
2190
	}
2191
2192
	/**
2193
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2194
	 *
2195
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2196
	 * @param string $name  Option name
2197
	 * @param mixed  $value Option value
2198
	 */
2199
	public static function update_option( $name, $value ) {
2200
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2201
		return Jetpack_Options::update_option( $name, $value );
2202
	}
2203
2204
	/**
2205
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2206
	 *
2207
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2208
	 * @param array $array array( option name => option value, ... )
2209
	 */
2210
	public static function update_options( $array ) {
2211
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2212
		return Jetpack_Options::update_options( $array );
2213
	}
2214
2215
	/**
2216
	 * Deletes the given option.  May be passed multiple option names as an array.
2217
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2218
	 *
2219
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2220
	 * @param string|array $names
2221
	 */
2222
	public static function delete_option( $names ) {
2223
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2224
		return Jetpack_Options::delete_option( $names );
2225
	}
2226
2227
	/**
2228
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2229
	 *
2230
	 * Enters a user token into the user_tokens option
2231
	 *
2232
	 * @param int    $user_id The user id.
2233
	 * @param string $token The user token.
2234
	 * @param bool   $is_master_user Whether the user is the master user.
2235
	 * @return bool
2236
	 */
2237
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2238
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2239
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2240
	}
2241
2242
	/**
2243
	 * Returns an array of all PHP files in the specified absolute path.
2244
	 * Equivalent to glob( "$absolute_path/*.php" ).
2245
	 *
2246
	 * @param string $absolute_path The absolute path of the directory to search.
2247
	 * @return array Array of absolute paths to the PHP files.
2248
	 */
2249
	public static function glob_php( $absolute_path ) {
2250
		if ( function_exists( 'glob' ) ) {
2251
			return glob( "$absolute_path/*.php" );
2252
		}
2253
2254
		$absolute_path = untrailingslashit( $absolute_path );
2255
		$files         = array();
2256
		if ( ! $dir = @opendir( $absolute_path ) ) {
2257
			return $files;
2258
		}
2259
2260
		while ( false !== $file = readdir( $dir ) ) {
2261
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2262
				continue;
2263
			}
2264
2265
			$file = "$absolute_path/$file";
2266
2267
			if ( ! is_file( $file ) ) {
2268
				continue;
2269
			}
2270
2271
			$files[] = $file;
2272
		}
2273
2274
		closedir( $dir );
2275
2276
		return $files;
2277
	}
2278
2279
	public static function activate_new_modules( $redirect = false ) {
2280
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2281
			return;
2282
		}
2283
2284
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2285 View Code Duplication
		if ( ! $jetpack_old_version ) {
2286
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2287
			/** This action is documented in class.jetpack.php */
2288
			do_action( 'updating_jetpack_version', $version, false );
2289
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2290
		}
2291
2292
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2293
2294
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2295
			return;
2296
		}
2297
2298
		$active_modules     = self::get_active_modules();
2299
		$reactivate_modules = array();
2300
		foreach ( $active_modules as $active_module ) {
2301
			$module = self::get_module( $active_module );
2302
			if ( ! isset( $module['changed'] ) ) {
2303
				continue;
2304
			}
2305
2306
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2307
				continue;
2308
			}
2309
2310
			$reactivate_modules[] = $active_module;
2311
			self::deactivate_module( $active_module );
2312
		}
2313
2314
		$new_version = JETPACK__VERSION . ':' . time();
2315
		/** This action is documented in class.jetpack.php */
2316
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2317
		Jetpack_Options::update_options(
2318
			array(
2319
				'version'     => $new_version,
2320
				'old_version' => $jetpack_old_version,
2321
			)
2322
		);
2323
2324
		self::state( 'message', 'modules_activated' );
2325
		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...
2326
2327
		if ( $redirect ) {
2328
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2329
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2330
				$page = $_GET['page'];
2331
			}
2332
2333
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2334
			exit;
2335
		}
2336
	}
2337
2338
	/**
2339
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2340
	 * Make sure to tuck away module "library" files in a sub-directory.
2341
	 */
2342
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2343
		static $modules = null;
2344
2345
		if ( ! isset( $modules ) ) {
2346
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2347
			// Use the cache if we're on the front-end and it's available...
2348
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2349
				$modules = $available_modules_option[ JETPACK__VERSION ];
2350
			} else {
2351
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2352
2353
				$modules = array();
2354
2355
				foreach ( $files as $file ) {
2356
					if ( ! $headers = self::get_module( $file ) ) {
2357
						continue;
2358
					}
2359
2360
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2361
				}
2362
2363
				Jetpack_Options::update_option(
2364
					'available_modules',
2365
					array(
2366
						JETPACK__VERSION => $modules,
2367
					)
2368
				);
2369
			}
2370
		}
2371
2372
		/**
2373
		 * Filters the array of modules available to be activated.
2374
		 *
2375
		 * @since 2.4.0
2376
		 *
2377
		 * @param array $modules Array of available modules.
2378
		 * @param string $min_version Minimum version number required to use modules.
2379
		 * @param string $max_version Maximum version number required to use modules.
2380
		 */
2381
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2382
2383
		if ( ! $min_version && ! $max_version ) {
2384
			return array_keys( $mods );
2385
		}
2386
2387
		$r = array();
2388
		foreach ( $mods as $slug => $introduced ) {
2389
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2390
				continue;
2391
			}
2392
2393
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2394
				continue;
2395
			}
2396
2397
			$r[] = $slug;
2398
		}
2399
2400
		return $r;
2401
	}
2402
2403
	/**
2404
	 * Default modules loaded on activation.
2405
	 */
2406
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2407
		$return = array();
2408
2409
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2410
			$module_data = self::get_module( $module );
2411
2412
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2413
				case 'yes':
2414
					$return[] = $module;
2415
					break;
2416
				case 'public':
2417
					if ( Jetpack_Options::get_option( 'public' ) ) {
2418
						$return[] = $module;
2419
					}
2420
					break;
2421
				case 'no':
2422
				default:
2423
					break;
2424
			}
2425
		}
2426
		/**
2427
		 * Filters the array of default modules.
2428
		 *
2429
		 * @since 2.5.0
2430
		 *
2431
		 * @param array $return Array of default modules.
2432
		 * @param string $min_version Minimum version number required to use modules.
2433
		 * @param string $max_version Maximum version number required to use modules.
2434
		 */
2435
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2436
	}
2437
2438
	/**
2439
	 * Checks activated modules during auto-activation to determine
2440
	 * if any of those modules are being deprecated.  If so, close
2441
	 * them out, and add any replacement modules.
2442
	 *
2443
	 * Runs at priority 99 by default.
2444
	 *
2445
	 * This is run late, so that it can still activate a module if
2446
	 * the new module is a replacement for another that the user
2447
	 * currently has active, even if something at the normal priority
2448
	 * would kibosh everything.
2449
	 *
2450
	 * @since 2.6
2451
	 * @uses jetpack_get_default_modules filter
2452
	 * @param array $modules
2453
	 * @return array
2454
	 */
2455
	function handle_deprecated_modules( $modules ) {
2456
		$deprecated_modules = array(
2457
			'debug'            => null,  // Closed out and moved to the debugger library.
2458
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2459
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2460
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2461
		);
2462
2463
		// Don't activate SSO if they never completed activating WPCC.
2464
		if ( self::is_module_active( 'wpcc' ) ) {
2465
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2466
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2467
				$deprecated_modules['wpcc'] = null;
2468
			}
2469
		}
2470
2471
		foreach ( $deprecated_modules as $module => $replacement ) {
2472
			if ( self::is_module_active( $module ) ) {
2473
				self::deactivate_module( $module );
2474
				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...
2475
					$modules[] = $replacement;
2476
				}
2477
			}
2478
		}
2479
2480
		return array_unique( $modules );
2481
	}
2482
2483
	/**
2484
	 * Checks activated plugins during auto-activation to determine
2485
	 * if any of those plugins are in the list with a corresponding module
2486
	 * that is not compatible with the plugin. The module will not be allowed
2487
	 * to auto-activate.
2488
	 *
2489
	 * @since 2.6
2490
	 * @uses jetpack_get_default_modules filter
2491
	 * @param array $modules
2492
	 * @return array
2493
	 */
2494
	function filter_default_modules( $modules ) {
2495
2496
		$active_plugins = self::get_active_plugins();
2497
2498
		if ( ! empty( $active_plugins ) ) {
2499
2500
			// For each module we'd like to auto-activate...
2501
			foreach ( $modules as $key => $module ) {
2502
				// If there are potential conflicts for it...
2503
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2504
					// For each potential conflict...
2505
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2506
						// If that conflicting plugin is active...
2507
						if ( in_array( $plugin, $active_plugins ) ) {
2508
							// Remove that item from being auto-activated.
2509
							unset( $modules[ $key ] );
2510
						}
2511
					}
2512
				}
2513
			}
2514
		}
2515
2516
		return $modules;
2517
	}
2518
2519
	/**
2520
	 * Extract a module's slug from its full path.
2521
	 */
2522
	public static function get_module_slug( $file ) {
2523
		return str_replace( '.php', '', basename( $file ) );
2524
	}
2525
2526
	/**
2527
	 * Generate a module's path from its slug.
2528
	 */
2529
	public static function get_module_path( $slug ) {
2530
		/**
2531
		 * Filters the path of a modules.
2532
		 *
2533
		 * @since 7.4.0
2534
		 *
2535
		 * @param array $return The absolute path to a module's root php file
2536
		 * @param string $slug The module slug
2537
		 */
2538
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2539
	}
2540
2541
	/**
2542
	 * Load module data from module file. Headers differ from WordPress
2543
	 * plugin headers to avoid them being identified as standalone
2544
	 * plugins on the WordPress plugins page.
2545
	 */
2546
	public static function get_module( $module ) {
2547
		$headers = array(
2548
			'name'                      => 'Module Name',
2549
			'description'               => 'Module Description',
2550
			'sort'                      => 'Sort Order',
2551
			'recommendation_order'      => 'Recommendation Order',
2552
			'introduced'                => 'First Introduced',
2553
			'changed'                   => 'Major Changes In',
2554
			'deactivate'                => 'Deactivate',
2555
			'free'                      => 'Free',
2556
			'requires_connection'       => 'Requires Connection',
2557
			'auto_activate'             => 'Auto Activate',
2558
			'module_tags'               => 'Module Tags',
2559
			'feature'                   => 'Feature',
2560
			'additional_search_queries' => 'Additional Search Queries',
2561
			'plan_classes'              => 'Plans',
2562
		);
2563
2564
		$file = self::get_module_path( self::get_module_slug( $module ) );
2565
2566
		$mod = self::get_file_data( $file, $headers );
2567
		if ( empty( $mod['name'] ) ) {
2568
			return false;
2569
		}
2570
2571
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2572
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2573
		$mod['deactivate']           = empty( $mod['deactivate'] );
2574
		$mod['free']                 = empty( $mod['free'] );
2575
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2576
2577
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2578
			$mod['auto_activate'] = 'No';
2579
		} else {
2580
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2581
		}
2582
2583
		if ( $mod['module_tags'] ) {
2584
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2585
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2586
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2587
		} else {
2588
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2589
		}
2590
2591 View Code Duplication
		if ( $mod['plan_classes'] ) {
2592
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2593
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2594
		} else {
2595
			$mod['plan_classes'] = array( 'free' );
2596
		}
2597
2598 View Code Duplication
		if ( $mod['feature'] ) {
2599
			$mod['feature'] = explode( ',', $mod['feature'] );
2600
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2601
		} else {
2602
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2603
		}
2604
2605
		/**
2606
		 * Filters the feature array on a module.
2607
		 *
2608
		 * This filter allows you to control where each module is filtered: Recommended,
2609
		 * and the default "Other" listing.
2610
		 *
2611
		 * @since 3.5.0
2612
		 *
2613
		 * @param array   $mod['feature'] The areas to feature this module:
2614
		 *     'Recommended' shows on the main Jetpack admin screen.
2615
		 *     'Other' should be the default if no other value is in the array.
2616
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2617
		 * @param array   $mod All the currently assembled module data.
2618
		 */
2619
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2620
2621
		/**
2622
		 * Filter the returned data about a module.
2623
		 *
2624
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2625
		 * so please be careful.
2626
		 *
2627
		 * @since 3.6.0
2628
		 *
2629
		 * @param array   $mod    The details of the requested module.
2630
		 * @param string  $module The slug of the module, e.g. sharedaddy
2631
		 * @param string  $file   The path to the module source file.
2632
		 */
2633
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2634
	}
2635
2636
	/**
2637
	 * Like core's get_file_data implementation, but caches the result.
2638
	 */
2639
	public static function get_file_data( $file, $headers ) {
2640
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2641
		$file_name = basename( $file );
2642
2643
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2644
2645
		$file_data_option = get_transient( $cache_key );
2646
2647
		if ( ! is_array( $file_data_option ) ) {
2648
			delete_transient( $cache_key );
2649
			$file_data_option = false;
2650
		}
2651
2652
		if ( false === $file_data_option ) {
2653
			$file_data_option = array();
2654
		}
2655
2656
		$key           = md5( $file_name . serialize( $headers ) );
2657
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2658
2659
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2660
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2661
			return $file_data_option[ $key ];
2662
		}
2663
2664
		$data = get_file_data( $file, $headers );
2665
2666
		$file_data_option[ $key ] = $data;
2667
2668
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2669
2670
		return $data;
2671
	}
2672
2673
2674
	/**
2675
	 * Return translated module tag.
2676
	 *
2677
	 * @param string $tag Tag as it appears in each module heading.
2678
	 *
2679
	 * @return mixed
2680
	 */
2681
	public static function translate_module_tag( $tag ) {
2682
		return jetpack_get_module_i18n_tag( $tag );
2683
	}
2684
2685
	/**
2686
	 * Get i18n strings as a JSON-encoded string
2687
	 *
2688
	 * @return string The locale as JSON
2689
	 */
2690
	public static function get_i18n_data_json() {
2691
2692
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2693
		// JSON files with the file they should be included for. This is an md5
2694
		// of '_inc/build/admin.js'.
2695
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2696
2697
		$i18n_json =
2698
				   JETPACK__PLUGIN_DIR
2699
				   . 'languages/json/jetpack-'
2700
				   . get_user_locale()
2701
				   . '-'
2702
				   . $path_md5
2703
				   . '.json';
2704
2705
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2706
			$locale_data = @file_get_contents( $i18n_json );
2707
			if ( $locale_data ) {
2708
				return $locale_data;
2709
			}
2710
		}
2711
2712
		// Return valid empty Jed locale
2713
		return '{ "locale_data": { "messages": { "": {} } } }';
2714
	}
2715
2716
	/**
2717
	 * Add locale data setup to wp-i18n
2718
	 *
2719
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2720
	 *
2721
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2722
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2723
	 *
2724
	 * This method provides a safe way to request the setup multiple times but add the script at
2725
	 * most once.
2726
	 *
2727
	 * @since 6.7.0
2728
	 *
2729
	 * @return void
2730
	 */
2731
	public static function setup_wp_i18n_locale_data() {
2732
		static $script_added = false;
2733
		if ( ! $script_added ) {
2734
			$script_added = true;
2735
			wp_add_inline_script(
2736
				'wp-i18n',
2737
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2738
			);
2739
		}
2740
	}
2741
2742
	/**
2743
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2744
	 *
2745
	 * @since 3.9.2
2746
	 *
2747
	 * @param array $modules
2748
	 *
2749
	 * @return string|void
2750
	 */
2751
	public static function get_translated_modules( $modules ) {
2752
		foreach ( $modules as $index => $module ) {
2753
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2754
			if ( isset( $module['name'] ) ) {
2755
				$modules[ $index ]['name'] = $i18n_module['name'];
2756
			}
2757
			if ( isset( $module['description'] ) ) {
2758
				$modules[ $index ]['description']       = $i18n_module['description'];
2759
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2760
			}
2761
		}
2762
		return $modules;
2763
	}
2764
2765
	/**
2766
	 * Get a list of activated modules as an array of module slugs.
2767
	 */
2768
	public static function get_active_modules() {
2769
		$active = Jetpack_Options::get_option( 'active_modules' );
2770
2771
		if ( ! is_array( $active ) ) {
2772
			$active = array();
2773
		}
2774
2775
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2776
			$active[] = 'vaultpress';
2777
		} else {
2778
			$active = array_diff( $active, array( 'vaultpress' ) );
2779
		}
2780
2781
		// If protect is active on the main site of a multisite, it should be active on all sites.
2782
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2783
			$active[] = 'protect';
2784
		}
2785
2786
		/**
2787
		 * Allow filtering of the active modules.
2788
		 *
2789
		 * Gives theme and plugin developers the power to alter the modules that
2790
		 * are activated on the fly.
2791
		 *
2792
		 * @since 5.8.0
2793
		 *
2794
		 * @param array $active Array of active module slugs.
2795
		 */
2796
		$active = apply_filters( 'jetpack_active_modules', $active );
2797
2798
		return array_unique( $active );
2799
	}
2800
2801
	/**
2802
	 * Check whether or not a Jetpack module is active.
2803
	 *
2804
	 * @param string $module The slug of a Jetpack module.
2805
	 * @return bool
2806
	 *
2807
	 * @static
2808
	 */
2809
	public static function is_module_active( $module ) {
2810
		return in_array( $module, self::get_active_modules() );
2811
	}
2812
2813
	public static function is_module( $module ) {
2814
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2815
	}
2816
2817
	/**
2818
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2819
	 *
2820
	 * @param bool $catch True to start catching, False to stop.
2821
	 *
2822
	 * @static
2823
	 */
2824
	public static function catch_errors( $catch ) {
2825
		static $display_errors, $error_reporting;
2826
2827
		if ( $catch ) {
2828
			$display_errors  = @ini_set( 'display_errors', 1 );
2829
			$error_reporting = @error_reporting( E_ALL );
2830
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2831
		} else {
2832
			@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...
2833
			@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...
2834
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2835
		}
2836
	}
2837
2838
	/**
2839
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2840
	 */
2841
	public static function catch_errors_on_shutdown() {
2842
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2843
	}
2844
2845
	/**
2846
	 * Rewrite any string to make paths easier to read.
2847
	 *
2848
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2849
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2850
	 *
2851
	 * @param $string
2852
	 * @return mixed
2853
	 */
2854
	public static function alias_directories( $string ) {
2855
		// ABSPATH has a trailing slash.
2856
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2857
		// WP_CONTENT_DIR does not have a trailing slash.
2858
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2859
2860
		return $string;
2861
	}
2862
2863
	public static function activate_default_modules(
2864
		$min_version = false,
2865
		$max_version = false,
2866
		$other_modules = array(),
2867
		$redirect = null,
2868
		$send_state_messages = null
2869
	) {
2870
		$jetpack = self::init();
2871
2872
		if ( is_null( $redirect ) ) {
2873
			if (
2874
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2875
			||
2876
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2877
			||
2878
				( defined( 'WP_CLI' ) && WP_CLI )
2879
			||
2880
				( defined( 'DOING_CRON' ) && DOING_CRON )
2881
			||
2882
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2883
			) {
2884
				$redirect = false;
2885
			} elseif ( is_admin() ) {
2886
				$redirect = true;
2887
			} else {
2888
				$redirect = false;
2889
			}
2890
		}
2891
2892
		if ( is_null( $send_state_messages ) ) {
2893
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2894
		}
2895
2896
		$modules = self::get_default_modules( $min_version, $max_version );
2897
		$modules = array_merge( $other_modules, $modules );
2898
2899
		// Look for standalone plugins and disable if active.
2900
2901
		$to_deactivate = array();
2902
		foreach ( $modules as $module ) {
2903
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2904
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2905
			}
2906
		}
2907
2908
		$deactivated = array();
2909
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2910
			list( $probable_file, $probable_title ) = $deactivate_me;
2911
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2912
				$deactivated[] = $module;
2913
			}
2914
		}
2915
2916
		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...
2917
			if ( $send_state_messages ) {
2918
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2919
			}
2920
2921
			if ( $redirect ) {
2922
				$url = add_query_arg(
2923
					array(
2924
						'action'   => 'activate_default_modules',
2925
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2926
					),
2927
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2928
				);
2929
				wp_safe_redirect( $url );
2930
				exit;
2931
			}
2932
		}
2933
2934
		/**
2935
		 * Fires before default modules are activated.
2936
		 *
2937
		 * @since 1.9.0
2938
		 *
2939
		 * @param string $min_version Minimum version number required to use modules.
2940
		 * @param string $max_version Maximum version number required to use modules.
2941
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2942
		 */
2943
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2944
2945
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2946
		if ( $send_state_messages ) {
2947
			self::restate();
2948
			self::catch_errors( true );
2949
		}
2950
2951
		$active = self::get_active_modules();
2952
2953
		foreach ( $modules as $module ) {
2954
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2955
				$active[] = $module;
2956
				self::update_active_modules( $active );
2957
				continue;
2958
			}
2959
2960
			if ( $send_state_messages && in_array( $module, $active ) ) {
2961
				$module_info = self::get_module( $module );
2962 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2963
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2964
					if ( $active_state = self::state( $state ) ) {
2965
						$active_state = explode( ',', $active_state );
2966
					} else {
2967
						$active_state = array();
2968
					}
2969
					$active_state[] = $module;
2970
					self::state( $state, implode( ',', $active_state ) );
2971
				}
2972
				continue;
2973
			}
2974
2975
			$file = self::get_module_path( $module );
2976
			if ( ! file_exists( $file ) ) {
2977
				continue;
2978
			}
2979
2980
			// we'll override this later if the plugin can be included without fatal error
2981
			if ( $redirect ) {
2982
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2983
			}
2984
2985
			if ( $send_state_messages ) {
2986
				self::state( 'error', 'module_activation_failed' );
2987
				self::state( 'module', $module );
2988
			}
2989
2990
			ob_start();
2991
			require_once $file;
2992
2993
			$active[] = $module;
2994
2995 View Code Duplication
			if ( $send_state_messages ) {
2996
2997
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2998
				if ( $active_state = self::state( $state ) ) {
2999
					$active_state = explode( ',', $active_state );
3000
				} else {
3001
					$active_state = array();
3002
				}
3003
				$active_state[] = $module;
3004
				self::state( $state, implode( ',', $active_state ) );
3005
			}
3006
3007
			self::update_active_modules( $active );
3008
3009
			ob_end_clean();
3010
		}
3011
3012
		if ( $send_state_messages ) {
3013
			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...
3014
			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...
3015
		}
3016
3017
		self::catch_errors( false );
3018
		/**
3019
		 * Fires when default modules are activated.
3020
		 *
3021
		 * @since 1.9.0
3022
		 *
3023
		 * @param string $min_version Minimum version number required to use modules.
3024
		 * @param string $max_version Maximum version number required to use modules.
3025
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
3026
		 */
3027
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
3028
	}
3029
3030
	public static function activate_module( $module, $exit = true, $redirect = true ) {
3031
		/**
3032
		 * Fires before a module is activated.
3033
		 *
3034
		 * @since 2.6.0
3035
		 *
3036
		 * @param string $module Module slug.
3037
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
3038
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
3039
		 */
3040
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
3041
3042
		$jetpack = self::init();
3043
3044
		if ( ! strlen( $module ) ) {
3045
			return false;
3046
		}
3047
3048
		if ( ! self::is_module( $module ) ) {
3049
			return false;
3050
		}
3051
3052
		// If it's already active, then don't do it again
3053
		$active = self::get_active_modules();
3054
		foreach ( $active as $act ) {
3055
			if ( $act == $module ) {
3056
				return true;
3057
			}
3058
		}
3059
3060
		$module_data = self::get_module( $module );
3061
3062
		$is_development_mode = ( new Status() )->is_development_mode();
3063
		if ( ! self::is_active() ) {
3064
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
3065
				return false;
3066
			}
3067
3068
			// If we're not connected but in development mode, make sure the module doesn't require a connection
3069
			if ( $is_development_mode && $module_data['requires_connection'] ) {
3070
				return false;
3071
			}
3072
		}
3073
3074
		// Check and see if the old plugin is active
3075
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3076
			// Deactivate the old plugin
3077
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3078
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3079
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3080
				self::state( 'deactivated_plugins', $module );
3081
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3082
				exit;
3083
			}
3084
		}
3085
3086
		// Protect won't work with mis-configured IPs
3087
		if ( 'protect' === $module ) {
3088
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3089
			if ( ! jetpack_protect_get_ip() ) {
3090
				self::state( 'message', 'protect_misconfigured_ip' );
3091
				return false;
3092
			}
3093
		}
3094
3095
		if ( ! Jetpack_Plan::supports( $module ) ) {
3096
			return false;
3097
		}
3098
3099
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3100
		self::state( 'module', $module );
3101
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3102
3103
		self::catch_errors( true );
3104
		ob_start();
3105
		require self::get_module_path( $module );
3106
		/** This action is documented in class.jetpack.php */
3107
		do_action( 'jetpack_activate_module', $module );
3108
		$active[] = $module;
3109
		self::update_active_modules( $active );
3110
3111
		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...
3112
		ob_end_clean();
3113
		self::catch_errors( false );
3114
3115
		if ( $redirect ) {
3116
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3117
		}
3118
		if ( $exit ) {
3119
			exit;
3120
		}
3121
		return true;
3122
	}
3123
3124
	function activate_module_actions( $module ) {
3125
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3126
	}
3127
3128
	public static function deactivate_module( $module ) {
3129
		/**
3130
		 * Fires when a module is deactivated.
3131
		 *
3132
		 * @since 1.9.0
3133
		 *
3134
		 * @param string $module Module slug.
3135
		 */
3136
		do_action( 'jetpack_pre_deactivate_module', $module );
3137
3138
		$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...
3139
3140
		$active = self::get_active_modules();
3141
		$new    = array_filter( array_diff( $active, (array) $module ) );
3142
3143
		return self::update_active_modules( $new );
3144
	}
3145
3146
	public static function enable_module_configurable( $module ) {
3147
		$module = self::get_module_slug( $module );
3148
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3149
	}
3150
3151
	/**
3152
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3153
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3154
	 *
3155
	 * @param string $module Module slug
3156
	 * @return string $url module configuration URL
3157
	 */
3158
	public static function module_configuration_url( $module ) {
3159
		$module      = self::get_module_slug( $module );
3160
		$default_url = self::admin_url() . "#/settings?term=$module";
3161
		/**
3162
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3163
		 *
3164
		 * @since 6.9.0
3165
		 *
3166
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3167
		 */
3168
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3169
3170
		return $url;
3171
	}
3172
3173
	/* Installation */
3174
	public static function bail_on_activation( $message, $deactivate = true ) {
3175
		?>
3176
<!doctype html>
3177
<html>
3178
<head>
3179
<meta charset="<?php bloginfo( 'charset' ); ?>">
3180
<style>
3181
* {
3182
	text-align: center;
3183
	margin: 0;
3184
	padding: 0;
3185
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3186
}
3187
p {
3188
	margin-top: 1em;
3189
	font-size: 18px;
3190
}
3191
</style>
3192
<body>
3193
<p><?php echo esc_html( $message ); ?></p>
3194
</body>
3195
</html>
3196
		<?php
3197
		if ( $deactivate ) {
3198
			$plugins = get_option( 'active_plugins' );
3199
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3200
			$update  = false;
3201
			foreach ( $plugins as $i => $plugin ) {
3202
				if ( $plugin === $jetpack ) {
3203
					$plugins[ $i ] = false;
3204
					$update        = true;
3205
				}
3206
			}
3207
3208
			if ( $update ) {
3209
				update_option( 'active_plugins', array_filter( $plugins ) );
3210
			}
3211
		}
3212
		exit;
3213
	}
3214
3215
	/**
3216
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3217
	 *
3218
	 * @static
3219
	 */
3220
	public static function plugin_activation( $network_wide ) {
3221
		Jetpack_Options::update_option( 'activated', 1 );
3222
3223
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3224
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3225
		}
3226
3227
		if ( $network_wide ) {
3228
			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...
3229
		}
3230
3231
		// For firing one-off events (notices) immediately after activation
3232
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3233
3234
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3235
3236
		Health::on_jetpack_activated();
3237
3238
		self::plugin_initialize();
3239
	}
3240
3241
	public static function get_activation_source( $referer_url ) {
3242
3243
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3244
			return array( 'wp-cli', null );
3245
		}
3246
3247
		$referer = wp_parse_url( $referer_url );
3248
3249
		$source_type  = 'unknown';
3250
		$source_query = null;
3251
3252
		if ( ! is_array( $referer ) ) {
3253
			return array( $source_type, $source_query );
3254
		}
3255
3256
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3257
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3258
3259
		if ( isset( $referer['query'] ) ) {
3260
			parse_str( $referer['query'], $query_parts );
3261
		} else {
3262
			$query_parts = array();
3263
		}
3264
3265
		if ( $plugins_path === $referer['path'] ) {
3266
			$source_type = 'list';
3267
		} elseif ( $plugins_install_path === $referer['path'] ) {
3268
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3269
			switch ( $tab ) {
3270
				case 'popular':
3271
					$source_type = 'popular';
3272
					break;
3273
				case 'recommended':
3274
					$source_type = 'recommended';
3275
					break;
3276
				case 'favorites':
3277
					$source_type = 'favorites';
3278
					break;
3279
				case 'search':
3280
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3281
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3282
					break;
3283
				default:
3284
					$source_type = 'featured';
3285
			}
3286
		}
3287
3288
		return array( $source_type, $source_query );
3289
	}
3290
3291
	/**
3292
	 * Runs before bumping version numbers up to a new version
3293
	 *
3294
	 * @param  string $version    Version:timestamp
3295
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3296
	 * @return null              [description]
3297
	 */
3298
	public static function do_version_bump( $version, $old_version ) {
3299
		if ( ! $old_version ) { // For new sites
3300
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3301
		}
3302
	}
3303
3304
	/**
3305
	 * Sets the internal version number and activation state.
3306
	 *
3307
	 * @static
3308
	 */
3309
	public static function plugin_initialize() {
3310
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3311
			Jetpack_Options::update_option( 'activated', 2 );
3312
		}
3313
3314 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3315
			$version = $old_version = JETPACK__VERSION . ':' . time();
3316
			/** This action is documented in class.jetpack.php */
3317
			do_action( 'updating_jetpack_version', $version, false );
3318
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3319
		}
3320
3321
		self::load_modules();
3322
3323
		Jetpack_Options::delete_option( 'do_activate' );
3324
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3325
	}
3326
3327
	/**
3328
	 * Removes all connection options
3329
	 *
3330
	 * @static
3331
	 */
3332
	public static function plugin_deactivation() {
3333
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3334
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3335
			Jetpack_Network::init()->deactivate();
3336
		} else {
3337
			self::disconnect( false );
3338
			// Jetpack_Heartbeat::init()->deactivate();
3339
		}
3340
	}
3341
3342
	/**
3343
	 * Disconnects from the Jetpack servers.
3344
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3345
	 *
3346
	 * @static
3347
	 */
3348
	public static function disconnect( $update_activated_state = true ) {
3349
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3350
		$connection = self::connection();
3351
		$connection->clean_nonces( true );
3352
3353
		// If the site is in an IDC because sync is not allowed,
3354
		// let's make sure to not disconnect the production site.
3355
		if ( ! self::validate_sync_error_idc_option() ) {
3356
			$tracking = new Tracking();
3357
			$tracking->record_user_event( 'disconnect_site', array() );
3358
3359
			$connection->disconnect_site_wpcom();
3360
		}
3361
3362
		$connection->delete_all_connection_tokens();
3363
		Jetpack_IDC::clear_all_idc_options();
3364
3365
		if ( $update_activated_state ) {
3366
			Jetpack_Options::update_option( 'activated', 4 );
3367
		}
3368
3369
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3370
			// Check then record unique disconnection if site has never been disconnected previously
3371
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3372
				$jetpack_unique_connection['disconnected'] = 1;
3373
			} else {
3374
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3375
					// track unique disconnect
3376
					$jetpack = self::init();
3377
3378
					$jetpack->stat( 'connections', 'unique-disconnect' );
3379
					$jetpack->do_stats( 'server_side' );
3380
				}
3381
				// increment number of times disconnected
3382
				$jetpack_unique_connection['disconnected'] += 1;
3383
			}
3384
3385
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3386
		}
3387
3388
		// Delete all the sync related data. Since it could be taking up space.
3389
		Sender::get_instance()->uninstall();
3390
3391
		// Disable the Heartbeat cron
3392
		Jetpack_Heartbeat::init()->deactivate();
3393
	}
3394
3395
	/**
3396
	 * Unlinks the current user from the linked WordPress.com user.
3397
	 *
3398
	 * @deprecated since 7.7
3399
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3400
	 *
3401
	 * @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...
3402
	 * @return Boolean Whether the disconnection of the user was successful.
3403
	 */
3404
	public static function unlink_user( $user_id = null ) {
3405
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3406
		return Connection_Manager::disconnect_user( $user_id );
3407
	}
3408
3409
	/**
3410
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3411
	 */
3412
	public static function try_registration() {
3413
		$terms_of_service = new Terms_Of_Service();
3414
		// The user has agreed to the TOS at some point by now.
3415
		$terms_of_service->agree();
3416
3417
		// Let's get some testing in beta versions and such.
3418
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3419
			// Before attempting to connect, let's make sure that the domains are viable.
3420
			$domains_to_check = array_unique(
3421
				array(
3422
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3423
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3424
				)
3425
			);
3426
			foreach ( $domains_to_check as $domain ) {
3427
				$result = self::connection()->is_usable_domain( $domain );
3428
				if ( is_wp_error( $result ) ) {
3429
					return $result;
3430
				}
3431
			}
3432
		}
3433
3434
		$result = self::register();
3435
3436
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3437
		if ( ! $result || is_wp_error( $result ) ) {
3438
			return $result;
3439
		} else {
3440
			return true;
3441
		}
3442
	}
3443
3444
	/**
3445
	 * Tracking an internal event log. Try not to put too much chaff in here.
3446
	 *
3447
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3448
	 */
3449
	public static function log( $code, $data = null ) {
3450
		// only grab the latest 200 entries
3451
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3452
3453
		// Append our event to the log
3454
		$log_entry = array(
3455
			'time'    => time(),
3456
			'user_id' => get_current_user_id(),
3457
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3458
			'code'    => $code,
3459
		);
3460
		// Don't bother storing it unless we've got some.
3461
		if ( ! is_null( $data ) ) {
3462
			$log_entry['data'] = $data;
3463
		}
3464
		$log[] = $log_entry;
3465
3466
		// Try add_option first, to make sure it's not autoloaded.
3467
		// @todo: Add an add_option method to Jetpack_Options
3468
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3469
			Jetpack_Options::update_option( 'log', $log );
3470
		}
3471
3472
		/**
3473
		 * Fires when Jetpack logs an internal event.
3474
		 *
3475
		 * @since 3.0.0
3476
		 *
3477
		 * @param array $log_entry {
3478
		 *  Array of details about the log entry.
3479
		 *
3480
		 *  @param string time Time of the event.
3481
		 *  @param int user_id ID of the user who trigerred the event.
3482
		 *  @param int blog_id Jetpack Blog ID.
3483
		 *  @param string code Unique name for the event.
3484
		 *  @param string data Data about the event.
3485
		 * }
3486
		 */
3487
		do_action( 'jetpack_log_entry', $log_entry );
3488
	}
3489
3490
	/**
3491
	 * Get the internal event log.
3492
	 *
3493
	 * @param $event (string) - only return the specific log events
3494
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3495
	 *
3496
	 * @return array of log events || WP_Error for invalid params
3497
	 */
3498
	public static function get_log( $event = false, $num = false ) {
3499
		if ( $event && ! is_string( $event ) ) {
3500
			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...
3501
		}
3502
3503
		if ( $num && ! is_numeric( $num ) ) {
3504
			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...
3505
		}
3506
3507
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3508
3509
		// If nothing set - act as it did before, otherwise let's start customizing the output
3510
		if ( ! $num && ! $event ) {
3511
			return $entire_log;
3512
		} else {
3513
			$entire_log = array_reverse( $entire_log );
3514
		}
3515
3516
		$custom_log_output = array();
3517
3518
		if ( $event ) {
3519
			foreach ( $entire_log as $log_event ) {
3520
				if ( $event == $log_event['code'] ) {
3521
					$custom_log_output[] = $log_event;
3522
				}
3523
			}
3524
		} else {
3525
			$custom_log_output = $entire_log;
3526
		}
3527
3528
		if ( $num ) {
3529
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3530
		}
3531
3532
		return $custom_log_output;
3533
	}
3534
3535
	/**
3536
	 * Log modification of important settings.
3537
	 */
3538
	public static function log_settings_change( $option, $old_value, $value ) {
3539
		switch ( $option ) {
3540
			case 'jetpack_sync_non_public_post_stati':
3541
				self::log( $option, $value );
3542
				break;
3543
		}
3544
	}
3545
3546
	/**
3547
	 * Return stat data for WPCOM sync
3548
	 */
3549
	public static function get_stat_data( $encode = true, $extended = true ) {
3550
		$data = Jetpack_Heartbeat::generate_stats_array();
3551
3552
		if ( $extended ) {
3553
			$additional_data = self::get_additional_stat_data();
3554
			$data            = array_merge( $data, $additional_data );
3555
		}
3556
3557
		if ( $encode ) {
3558
			return json_encode( $data );
3559
		}
3560
3561
		return $data;
3562
	}
3563
3564
	/**
3565
	 * Get additional stat data to sync to WPCOM
3566
	 */
3567
	public static function get_additional_stat_data( $prefix = '' ) {
3568
		$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...
3569
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3570
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3571
		$return[ "{$prefix}site-count" ]    = 0;
3572
3573
		if ( function_exists( 'get_blog_count' ) ) {
3574
			$return[ "{$prefix}site-count" ] = get_blog_count();
3575
		}
3576
		return $return;
3577
	}
3578
3579
	private static function get_site_user_count() {
3580
		global $wpdb;
3581
3582
		if ( function_exists( 'wp_is_large_network' ) ) {
3583
			if ( wp_is_large_network( 'users' ) ) {
3584
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3585
			}
3586
		}
3587
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3588
			// It wasn't there, so regenerate the data and save the transient
3589
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3590
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3591
		}
3592
		return $user_count;
3593
	}
3594
3595
	/* Admin Pages */
3596
3597
	function admin_init() {
3598
		// If the plugin is not connected, display a connect message.
3599
		if (
3600
			// the plugin was auto-activated and needs its candy
3601
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3602
		||
3603
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3604
			! Jetpack_Options::get_option( 'activated' )
3605
		) {
3606
			self::plugin_initialize();
3607
		}
3608
3609
		$is_development_mode = ( new Status() )->is_development_mode();
3610
		if ( ! self::is_active() && ! $is_development_mode ) {
3611
			Jetpack_Connection_Banner::init();
3612
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3613
			// Upgrade: 1.1 -> 1.1.1
3614
			// Check and see if host can verify the Jetpack servers' SSL certificate
3615
			$args       = array();
3616
			$connection = self::connection();
3617
			Client::_wp_remote_request(
3618
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3619
				$args,
3620
				true
3621
			);
3622
		}
3623
3624
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3625
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3626
		}
3627
3628
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3629
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3630
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3631
3632
		if ( self::is_active() || $is_development_mode ) {
3633
			// Artificially throw errors in certain whitelisted cases during plugin activation
3634
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3635
		}
3636
3637
		// Add custom column in wp-admin/users.php to show whether user is linked.
3638
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3639
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3640
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3641
	}
3642
3643
	function admin_body_class( $admin_body_class = '' ) {
3644
		$classes = explode( ' ', trim( $admin_body_class ) );
3645
3646
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3647
3648
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3649
		return " $admin_body_class ";
3650
	}
3651
3652
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3653
		return $admin_body_class . ' jetpack-pagestyles ';
3654
	}
3655
3656
	/**
3657
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3658
	 * This function artificially throws errors for such cases (whitelisted).
3659
	 *
3660
	 * @param string $plugin The activated plugin.
3661
	 */
3662
	function throw_error_on_activate_plugin( $plugin ) {
3663
		$active_modules = self::get_active_modules();
3664
3665
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3666
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3667
			$throw = false;
3668
3669
			// Try and make sure it really was the stats plugin
3670
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3671
				if ( 'stats.php' == basename( $plugin ) ) {
3672
					$throw = true;
3673
				}
3674
			} else {
3675
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3676
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3677
					$throw = true;
3678
				}
3679
			}
3680
3681
			if ( $throw ) {
3682
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3683
			}
3684
		}
3685
	}
3686
3687
	function intercept_plugin_error_scrape_init() {
3688
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3689
	}
3690
3691
	function intercept_plugin_error_scrape( $action, $result ) {
3692
		if ( ! $result ) {
3693
			return;
3694
		}
3695
3696
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3697
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3698
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3699
			}
3700
		}
3701
	}
3702
3703
	/**
3704
	 * Register the remote file upload request handlers, if needed.
3705
	 *
3706
	 * @access public
3707
	 */
3708
	public function add_remote_request_handlers() {
3709
		// Remote file uploads are allowed only via AJAX requests.
3710
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3711
			return;
3712
		}
3713
3714
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3715
		$remote_request_actions = array(
3716
			'jetpack_upload_file',
3717
			'jetpack_update_file',
3718
		);
3719
3720
		// phpcs:ignore WordPress.Security.NonceVerification
3721
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3722
			return;
3723
		}
3724
3725
		// Require Jetpack authentication for the remote file upload AJAX requests.
3726
		if ( ! $this->connection_manager ) {
3727
			$this->connection_manager = new Connection_Manager();
3728
		}
3729
3730
		$this->connection_manager->require_jetpack_authentication();
3731
3732
		// Register the remote file upload AJAX handlers.
3733
		foreach ( $remote_request_actions as $action ) {
3734
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3735
		}
3736
	}
3737
3738
	/**
3739
	 * Handler for Jetpack remote file uploads.
3740
	 *
3741
	 * @access public
3742
	 */
3743
	public function remote_request_handlers() {
3744
		$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...
3745
3746
		switch ( current_filter() ) {
3747
			case 'wp_ajax_nopriv_jetpack_upload_file':
3748
				$response = $this->upload_handler();
3749
				break;
3750
3751
			case 'wp_ajax_nopriv_jetpack_update_file':
3752
				$response = $this->upload_handler( true );
3753
				break;
3754
			default:
3755
				$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...
3756
				break;
3757
		}
3758
3759
		if ( ! $response ) {
3760
			$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...
3761
		}
3762
3763
		if ( is_wp_error( $response ) ) {
3764
			$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...
3765
			$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...
3766
			$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...
3767
3768
			if ( ! is_int( $status_code ) ) {
3769
				$status_code = 400;
3770
			}
3771
3772
			status_header( $status_code );
3773
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3774
		}
3775
3776
		status_header( 200 );
3777
		if ( true === $response ) {
3778
			exit;
3779
		}
3780
3781
		die( json_encode( (object) $response ) );
3782
	}
3783
3784
	/**
3785
	 * Uploads a file gotten from the global $_FILES.
3786
	 * If `$update_media_item` is true and `post_id` is defined
3787
	 * the attachment file of the media item (gotten through of the post_id)
3788
	 * will be updated instead of add a new one.
3789
	 *
3790
	 * @param  boolean $update_media_item - update media attachment
3791
	 * @return array - An array describing the uploadind files process
3792
	 */
3793
	function upload_handler( $update_media_item = false ) {
3794
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3795
			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...
3796
		}
3797
3798
		$user = wp_authenticate( '', '' );
3799
		if ( ! $user || is_wp_error( $user ) ) {
3800
			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...
3801
		}
3802
3803
		wp_set_current_user( $user->ID );
3804
3805
		if ( ! current_user_can( 'upload_files' ) ) {
3806
			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...
3807
		}
3808
3809
		if ( empty( $_FILES ) ) {
3810
			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...
3811
		}
3812
3813
		foreach ( array_keys( $_FILES ) as $files_key ) {
3814
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3815
				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...
3816
			}
3817
		}
3818
3819
		$media_keys = array_keys( $_FILES['media'] );
3820
3821
		$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...
3822
		if ( ! $token || is_wp_error( $token ) ) {
3823
			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...
3824
		}
3825
3826
		$uploaded_files = array();
3827
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3828
		unset( $GLOBALS['post'] );
3829
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3830
			$file = array();
3831
			foreach ( $media_keys as $media_key ) {
3832
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3833
			}
3834
3835
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3836
3837
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3838
			if ( $hmac_provided !== $hmac_file ) {
3839
				$uploaded_files[ $index ] = (object) array(
3840
					'error'             => 'invalid_hmac',
3841
					'error_description' => 'The corresponding HMAC for this file does not match',
3842
				);
3843
				continue;
3844
			}
3845
3846
			$_FILES['.jetpack.upload.'] = $file;
3847
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3848
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3849
				$post_id = 0;
3850
			}
3851
3852
			if ( $update_media_item ) {
3853
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3854
					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...
3855
				}
3856
3857
				$media_array = $_FILES['media'];
3858
3859
				$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...
3860
				$file_array['type']     = $media_array['type'][0];
3861
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3862
				$file_array['error']    = $media_array['error'][0];
3863
				$file_array['size']     = $media_array['size'][0];
3864
3865
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3866
3867
				if ( is_wp_error( $edited_media_item ) ) {
3868
					return $edited_media_item;
3869
				}
3870
3871
				$response = (object) array(
3872
					'id'   => (string) $post_id,
3873
					'file' => (string) $edited_media_item->post_title,
3874
					'url'  => (string) wp_get_attachment_url( $post_id ),
3875
					'type' => (string) $edited_media_item->post_mime_type,
3876
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3877
				);
3878
3879
				return (array) array( $response );
3880
			}
3881
3882
			$attachment_id = media_handle_upload(
3883
				'.jetpack.upload.',
3884
				$post_id,
3885
				array(),
3886
				array(
3887
					'action' => 'jetpack_upload_file',
3888
				)
3889
			);
3890
3891
			if ( ! $attachment_id ) {
3892
				$uploaded_files[ $index ] = (object) array(
3893
					'error'             => 'unknown',
3894
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3895
				);
3896
			} elseif ( is_wp_error( $attachment_id ) ) {
3897
				$uploaded_files[ $index ] = (object) array(
3898
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3899
					'error_description' => $attachment_id->get_error_message(),
3900
				);
3901
			} else {
3902
				$attachment               = get_post( $attachment_id );
3903
				$uploaded_files[ $index ] = (object) array(
3904
					'id'   => (string) $attachment_id,
3905
					'file' => $attachment->post_title,
3906
					'url'  => wp_get_attachment_url( $attachment_id ),
3907
					'type' => $attachment->post_mime_type,
3908
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3909
				);
3910
				// Zip files uploads are not supported unless they are done for installation purposed
3911
				// lets delete them in case something goes wrong in this whole process
3912
				if ( 'application/zip' === $attachment->post_mime_type ) {
3913
					// Schedule a cleanup for 2 hours from now in case of failed install.
3914
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3915
				}
3916
			}
3917
		}
3918
		if ( ! is_null( $global_post ) ) {
3919
			$GLOBALS['post'] = $global_post;
3920
		}
3921
3922
		return $uploaded_files;
3923
	}
3924
3925
	/**
3926
	 * Add help to the Jetpack page
3927
	 *
3928
	 * @since Jetpack (1.2.3)
3929
	 * @return false if not the Jetpack page
3930
	 */
3931
	function admin_help() {
3932
		$current_screen = get_current_screen();
3933
3934
		// Overview
3935
		$current_screen->add_help_tab(
3936
			array(
3937
				'id'      => 'home',
3938
				'title'   => __( 'Home', 'jetpack' ),
3939
				'content' =>
3940
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3941
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3942
					'<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>',
3943
			)
3944
		);
3945
3946
		// Screen Content
3947
		if ( current_user_can( 'manage_options' ) ) {
3948
			$current_screen->add_help_tab(
3949
				array(
3950
					'id'      => 'settings',
3951
					'title'   => __( 'Settings', 'jetpack' ),
3952
					'content' =>
3953
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3954
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3955
						'<ol>' .
3956
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3957
							'<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>' .
3958
						'</ol>' .
3959
						'<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>',
3960
				)
3961
			);
3962
		}
3963
3964
		// Help Sidebar
3965
		$support_url = Redirect::get_url( 'jetpack-support' );
3966
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
3967
		$current_screen->set_help_sidebar(
3968
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3969
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3970
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3971
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3972
		);
3973
	}
3974
3975
	function admin_menu_css() {
3976
		wp_enqueue_style( 'jetpack-icons' );
3977
	}
3978
3979
	function admin_menu_order() {
3980
		return true;
3981
	}
3982
3983 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3984
		$jp_menu_order = array();
3985
3986
		foreach ( $menu_order as $index => $item ) {
3987
			if ( $item != 'jetpack' ) {
3988
				$jp_menu_order[] = $item;
3989
			}
3990
3991
			if ( $index == 0 ) {
3992
				$jp_menu_order[] = 'jetpack';
3993
			}
3994
		}
3995
3996
		return $jp_menu_order;
3997
	}
3998
3999
	function admin_banner_styles() {
4000
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
4001
4002 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
4003
			wp_register_style(
4004
				'jetpack-dops-style',
4005
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
4006
				array(),
4007
				JETPACK__VERSION
4008
			);
4009
		}
4010
4011
		wp_enqueue_style(
4012
			'jetpack',
4013
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
4014
			array( 'jetpack-dops-style' ),
4015
			JETPACK__VERSION . '-20121016'
4016
		);
4017
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
4018
		wp_style_add_data( 'jetpack', 'suffix', $min );
4019
	}
4020
4021
	function plugin_action_links( $actions ) {
4022
4023
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
4024
4025
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
4026
			return array_merge(
4027
				$jetpack_home,
4028
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
4029
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
4030
				$actions
4031
			);
4032
		}
4033
4034
		return array_merge( $jetpack_home, $actions );
4035
	}
4036
4037
	/**
4038
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4039
	 *
4040
	 * @param string $login_url The wp-login URL.
4041
	 * @param string $redirect  URL to redirect users after logging in.
4042
	 * @since Jetpack 8.4
4043
	 * @return string
4044
	 */
4045
	public function login_url( $login_url, $redirect ) {
4046
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
4047
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4048
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4049
		}
4050
		return $login_url;
4051
	}
4052
4053
	/**
4054
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4055
	 *
4056
	 * @since Jetpack 8.4
4057
	 */
4058
	public function login_init() {
4059
		// phpcs:ignore WordPress.Security.NonceVerification
4060
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4061
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4062
			wp_safe_redirect(
4063
				add_query_arg(
4064
					array(
4065
						'forceInstall' => 1,
4066
						'url'          => rawurlencode( get_site_url() ),
4067
					),
4068
					// @todo provide way to go to specific calypso env.
4069
					self::get_calypso_host() . 'jetpack/connect'
4070
				)
4071
			);
4072
			exit;
4073
		}
4074
	}
4075
4076
	/*
4077
	 * Registration flow:
4078
	 * 1 - ::admin_page_load() action=register
4079
	 * 2 - ::try_registration()
4080
	 * 3 - ::register()
4081
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4082
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4083
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4084
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4085
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4086
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4087
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4088
	 *       jetpack_id, jetpack_secret, jetpack_public
4089
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4090
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4091
	 * 5 - user logs in with WP.com account
4092
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4093
	 *		- Manager::authorize()
4094
	 *		- Manager::get_token()
4095
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4096
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4097
	 *			- which responds with access_token, token_type, scope
4098
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4099
	 *		- Jetpack::activate_default_modules()
4100
	 *     		- Deactivates deprecated plugins
4101
	 *     		- Activates all default modules
4102
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4103
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4104
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4105
	 *     Done!
4106
	 */
4107
4108
	/**
4109
	 * Handles the page load events for the Jetpack admin page
4110
	 */
4111
	function admin_page_load() {
4112
		$error = false;
4113
4114
		// Make sure we have the right body class to hook stylings for subpages off of.
4115
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4116
4117
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4118
			// Should only be used in intermediate redirects to preserve state across redirects
4119
			self::restate();
4120
		}
4121
4122
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4123
			// @todo: Add validation against a known whitelist
4124
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4125
			// User clicked in the iframe to link their accounts
4126
			if ( ! self::is_user_connected() ) {
4127
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4128
4129
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4130
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4131
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4132
4133
				if ( isset( $_GET['notes_iframe'] ) ) {
4134
					$connect_url .= '&notes_iframe';
4135
				}
4136
				wp_redirect( $connect_url );
4137
				exit;
4138
			} else {
4139
				if ( ! isset( $_GET['calypso_env'] ) ) {
4140
					self::state( 'message', 'already_authorized' );
4141
					wp_safe_redirect( self::admin_url() );
4142
					exit;
4143
				} else {
4144
					$connect_url  = $this->build_connect_url( true, false, $from );
4145
					$connect_url .= '&already_authorized=true';
4146
					wp_redirect( $connect_url );
4147
					exit;
4148
				}
4149
			}
4150
		}
4151
4152
		if ( isset( $_GET['action'] ) ) {
4153
			switch ( $_GET['action'] ) {
4154
				case 'authorize':
4155
					if ( self::is_active() && self::is_user_connected() ) {
4156
						self::state( 'message', 'already_authorized' );
4157
						wp_safe_redirect( self::admin_url() );
4158
						exit;
4159
					}
4160
					self::log( 'authorize' );
4161
					$client_server = new Jetpack_Client_Server();
4162
					$client_server->client_authorize();
4163
					exit;
4164
				case 'register':
4165
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4166
						$error = 'cheatin';
4167
						break;
4168
					}
4169
					check_admin_referer( 'jetpack-register' );
4170
					self::log( 'register' );
4171
					self::maybe_set_version_option();
4172
					$registered = self::try_registration();
4173 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4174
						$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...
4175
						self::state( 'error', $error );
4176
						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...
4177
4178
						/**
4179
						 * Jetpack registration Error.
4180
						 *
4181
						 * @since 7.5.0
4182
						 *
4183
						 * @param string|int $error The error code.
4184
						 * @param \WP_Error $registered The error object.
4185
						 */
4186
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4187
						break;
4188
					}
4189
4190
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4191
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4192
4193
					/**
4194
					 * Jetpack registration Success.
4195
					 *
4196
					 * @since 7.5.0
4197
					 *
4198
					 * @param string $from 'from' GET parameter;
4199
					 */
4200
					do_action( 'jetpack_connection_register_success', $from );
4201
4202
					$url = $this->build_connect_url( true, $redirect, $from );
4203
4204
					if ( ! empty( $_GET['onboarding'] ) ) {
4205
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4206
					}
4207
4208
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4209
						$url = add_query_arg( 'auth_approved', 'true', $url );
4210
					}
4211
4212
					wp_redirect( $url );
4213
					exit;
4214
				case 'activate':
4215
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4216
						$error = 'cheatin';
4217
						break;
4218
					}
4219
4220
					$module = stripslashes( $_GET['module'] );
4221
					check_admin_referer( "jetpack_activate-$module" );
4222
					self::log( 'activate', $module );
4223
					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...
4224
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4225
					}
4226
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4227
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4228
					exit;
4229
				case 'activate_default_modules':
4230
					check_admin_referer( 'activate_default_modules' );
4231
					self::log( 'activate_default_modules' );
4232
					self::restate();
4233
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4234
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4235
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4236
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4237
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4238
					exit;
4239
				case 'disconnect':
4240
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4241
						$error = 'cheatin';
4242
						break;
4243
					}
4244
4245
					check_admin_referer( 'jetpack-disconnect' );
4246
					self::log( 'disconnect' );
4247
					self::disconnect();
4248
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4249
					exit;
4250
				case 'reconnect':
4251
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4252
						$error = 'cheatin';
4253
						break;
4254
					}
4255
4256
					check_admin_referer( 'jetpack-reconnect' );
4257
					self::log( 'reconnect' );
4258
					$this->disconnect();
4259
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4260
					exit;
4261 View Code Duplication
				case 'deactivate':
4262
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4263
						$error = 'cheatin';
4264
						break;
4265
					}
4266
4267
					$modules = stripslashes( $_GET['module'] );
4268
					check_admin_referer( "jetpack_deactivate-$modules" );
4269
					foreach ( explode( ',', $modules ) as $module ) {
4270
						self::log( 'deactivate', $module );
4271
						self::deactivate_module( $module );
4272
						self::state( 'message', 'module_deactivated' );
4273
					}
4274
					self::state( 'module', $modules );
4275
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4276
					exit;
4277
				case 'unlink':
4278
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4279
					check_admin_referer( 'jetpack-unlink' );
4280
					self::log( 'unlink' );
4281
					Connection_Manager::disconnect_user();
4282
					self::state( 'message', 'unlinked' );
4283
					if ( 'sub-unlink' == $redirect ) {
4284
						wp_safe_redirect( admin_url() );
4285
					} else {
4286
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4287
					}
4288
					exit;
4289
				case 'onboard':
4290
					if ( ! current_user_can( 'manage_options' ) ) {
4291
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4292
					} else {
4293
						self::create_onboarding_token();
4294
						$url = $this->build_connect_url( true );
4295
4296
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4297
							$url = add_query_arg( 'onboarding', $token, $url );
4298
						}
4299
4300
						$calypso_env = $this->get_calypso_env();
4301
						if ( ! empty( $calypso_env ) ) {
4302
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4303
						}
4304
4305
						wp_redirect( $url );
4306
						exit;
4307
					}
4308
					exit;
4309
				default:
4310
					/**
4311
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4312
					 *
4313
					 * @since 2.6.0
4314
					 *
4315
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4316
					 */
4317
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4318
			}
4319
		}
4320
4321
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4322
			self::activate_new_modules( true );
4323
		}
4324
4325
		$message_code = self::state( 'message' );
4326
		if ( self::state( 'optin-manage' ) ) {
4327
			$activated_manage = $message_code;
4328
			$message_code     = 'jetpack-manage';
4329
		}
4330
4331
		switch ( $message_code ) {
4332
			case 'jetpack-manage':
4333
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4334
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4335
				$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' ), $sites_url ) . '</strong>';
4336
				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...
4337
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4338
				}
4339
				break;
4340
4341
		}
4342
4343
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4344
4345
		if ( ! empty( $deactivated_plugins ) ) {
4346
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4347
			$deactivated_titles  = array();
4348
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4349
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4350
					continue;
4351
				}
4352
4353
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4354
			}
4355
4356
			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...
4357
				if ( $this->message ) {
4358
					$this->message .= "<br /><br />\n";
4359
				}
4360
4361
				$this->message .= wp_sprintf(
4362
					_n(
4363
						'Jetpack contains the most recent version of the old %l plugin.',
4364
						'Jetpack contains the most recent versions of the old %l plugins.',
4365
						count( $deactivated_titles ),
4366
						'jetpack'
4367
					),
4368
					$deactivated_titles
4369
				);
4370
4371
				$this->message .= "<br />\n";
4372
4373
				$this->message .= _n(
4374
					'The old version has been deactivated and can be removed from your site.',
4375
					'The old versions have been deactivated and can be removed from your site.',
4376
					count( $deactivated_titles ),
4377
					'jetpack'
4378
				);
4379
			}
4380
		}
4381
4382
		$this->privacy_checks = self::state( 'privacy_checks' );
4383
4384
		if ( $this->message || $this->error || $this->privacy_checks ) {
4385
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4386
		}
4387
4388
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4389
	}
4390
4391
	function admin_notices() {
4392
4393
		if ( $this->error ) {
4394
			?>
4395
<div id="message" class="jetpack-message jetpack-err">
4396
	<div class="squeezer">
4397
		<h2>
4398
			<?php
4399
			echo wp_kses(
4400
				$this->error,
4401
				array(
4402
					'a'      => array( 'href' => array() ),
4403
					'small'  => true,
4404
					'code'   => true,
4405
					'strong' => true,
4406
					'br'     => true,
4407
					'b'      => true,
4408
				)
4409
			);
4410
			?>
4411
			</h2>
4412
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4413
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4414
<?php	endif; ?>
4415
	</div>
4416
</div>
4417
			<?php
4418
		}
4419
4420
		if ( $this->message ) {
4421
			?>
4422
<div id="message" class="jetpack-message">
4423
	<div class="squeezer">
4424
		<h2>
4425
			<?php
4426
			echo wp_kses(
4427
				$this->message,
4428
				array(
4429
					'strong' => array(),
4430
					'a'      => array( 'href' => true ),
4431
					'br'     => true,
4432
				)
4433
			);
4434
			?>
4435
			</h2>
4436
	</div>
4437
</div>
4438
			<?php
4439
		}
4440
4441
		if ( $this->privacy_checks ) :
4442
			$module_names = $module_slugs = array();
4443
4444
			$privacy_checks = explode( ',', $this->privacy_checks );
4445
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4446
			foreach ( $privacy_checks as $module_slug ) {
4447
				$module = self::get_module( $module_slug );
4448
				if ( ! $module ) {
4449
					continue;
4450
				}
4451
4452
				$module_slugs[] = $module_slug;
4453
				$module_names[] = "<strong>{$module['name']}</strong>";
4454
			}
4455
4456
			$module_slugs = join( ',', $module_slugs );
4457
			?>
4458
<div id="message" class="jetpack-message jetpack-err">
4459
	<div class="squeezer">
4460
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4461
		<p>
4462
			<?php
4463
			echo wp_kses(
4464
				wptexturize(
4465
					wp_sprintf(
4466
						_nx(
4467
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4468
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4469
							count( $privacy_checks ),
4470
							'%l = list of Jetpack module/feature names',
4471
							'jetpack'
4472
						),
4473
						$module_names
4474
					)
4475
				),
4476
				array( 'strong' => true )
4477
			);
4478
4479
			echo "\n<br />\n";
4480
4481
			echo wp_kses(
4482
				sprintf(
4483
					_nx(
4484
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4485
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4486
						count( $privacy_checks ),
4487
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4488
						'jetpack'
4489
					),
4490
					wp_nonce_url(
4491
						self::admin_url(
4492
							array(
4493
								'page'   => 'jetpack',
4494
								'action' => 'deactivate',
4495
								'module' => urlencode( $module_slugs ),
4496
							)
4497
						),
4498
						"jetpack_deactivate-$module_slugs"
4499
					),
4500
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4501
				),
4502
				array(
4503
					'a' => array(
4504
						'href'  => true,
4505
						'title' => true,
4506
					),
4507
				)
4508
			);
4509
			?>
4510
		</p>
4511
	</div>
4512
</div>
4513
			<?php
4514
endif;
4515
	}
4516
4517
	/**
4518
	 * We can't always respond to a signed XML-RPC request with a
4519
	 * helpful error message. In some circumstances, doing so could
4520
	 * leak information.
4521
	 *
4522
	 * Instead, track that the error occurred via a Jetpack_Option,
4523
	 * and send that data back in the heartbeat.
4524
	 * All this does is increment a number, but it's enough to find
4525
	 * trends.
4526
	 *
4527
	 * @param WP_Error $xmlrpc_error The error produced during
4528
	 *                               signature validation.
4529
	 */
4530
	function track_xmlrpc_error( $xmlrpc_error ) {
4531
		$code = is_wp_error( $xmlrpc_error )
4532
			? $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...
4533
			: 'should-not-happen';
4534
4535
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4536
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4537
			// No need to update the option if we already have
4538
			// this code stored.
4539
			return;
4540
		}
4541
		$xmlrpc_errors[ $code ] = true;
4542
4543
		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...
4544
	}
4545
4546
	/**
4547
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4548
	 */
4549
	function stat( $group, $detail ) {
4550
		if ( ! isset( $this->stats[ $group ] ) ) {
4551
			$this->stats[ $group ] = array();
4552
		}
4553
		$this->stats[ $group ][] = $detail;
4554
	}
4555
4556
	/**
4557
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4558
	 */
4559
	function do_stats( $method = '' ) {
4560
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4561
			foreach ( $this->stats as $group => $stats ) {
4562
				if ( is_array( $stats ) && count( $stats ) ) {
4563
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4564
					if ( 'server_side' === $method ) {
4565
						self::do_server_side_stat( $args );
4566
					} else {
4567
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4568
					}
4569
				}
4570
				unset( $this->stats[ $group ] );
4571
			}
4572
		}
4573
	}
4574
4575
	/**
4576
	 * Runs stats code for a one-off, server-side.
4577
	 *
4578
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4579
	 *
4580
	 * @return bool If it worked.
4581
	 */
4582
	static function do_server_side_stat( $args ) {
4583
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4584
		if ( is_wp_error( $response ) ) {
4585
			return false;
4586
		}
4587
4588
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4589
			return false;
4590
		}
4591
4592
		return true;
4593
	}
4594
4595
	/**
4596
	 * Builds the stats url.
4597
	 *
4598
	 * @param $args array|string The arguments to append to the URL.
4599
	 *
4600
	 * @return string The URL to be pinged.
4601
	 */
4602
	static function build_stats_url( $args ) {
4603
		$defaults = array(
4604
			'v'    => 'wpcom2',
4605
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4606
		);
4607
		$args     = wp_parse_args( $args, $defaults );
0 ignored issues
show
Documentation introduced by
$defaults is of type array<string,string,{"v"...ring","rand":"string"}>, but the function expects a string.

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...
4608
		/**
4609
		 * Filter the URL used as the Stats tracking pixel.
4610
		 *
4611
		 * @since 2.3.2
4612
		 *
4613
		 * @param string $url Base URL used as the Stats tracking pixel.
4614
		 */
4615
		$base_url = apply_filters(
4616
			'jetpack_stats_base_url',
4617
			'https://pixel.wp.com/g.gif'
4618
		);
4619
		$url      = add_query_arg( $args, $base_url );
4620
		return $url;
4621
	}
4622
4623
	/**
4624
	 * Get the role of the current user.
4625
	 *
4626
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4627
	 *
4628
	 * @access public
4629
	 * @static
4630
	 *
4631
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4632
	 */
4633
	public static function translate_current_user_to_role() {
4634
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4635
4636
		$roles = new Roles();
4637
		return $roles->translate_current_user_to_role();
4638
	}
4639
4640
	/**
4641
	 * Get the role of a particular user.
4642
	 *
4643
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4644
	 *
4645
	 * @access public
4646
	 * @static
4647
	 *
4648
	 * @param \WP_User $user User object.
4649
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4650
	 */
4651
	public static function translate_user_to_role( $user ) {
4652
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4653
4654
		$roles = new Roles();
4655
		return $roles->translate_user_to_role( $user );
4656
	}
4657
4658
	/**
4659
	 * Get the minimum capability for a role.
4660
	 *
4661
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4662
	 *
4663
	 * @access public
4664
	 * @static
4665
	 *
4666
	 * @param string $role Role name.
4667
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4668
	 */
4669
	public static function translate_role_to_cap( $role ) {
4670
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4671
4672
		$roles = new Roles();
4673
		return $roles->translate_role_to_cap( $role );
4674
	}
4675
4676
	/**
4677
	 * Sign a user role with the master access token.
4678
	 * If not specified, will default to the current user.
4679
	 *
4680
	 * @deprecated since 7.7
4681
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4682
	 *
4683
	 * @access public
4684
	 * @static
4685
	 *
4686
	 * @param string $role    User role.
4687
	 * @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...
4688
	 * @return string Signed user role.
4689
	 */
4690
	public static function sign_role( $role, $user_id = null ) {
4691
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4692
		return self::connection()->sign_role( $role, $user_id );
4693
	}
4694
4695
	/**
4696
	 * Builds a URL to the Jetpack connection auth page
4697
	 *
4698
	 * @since 3.9.5
4699
	 *
4700
	 * @param bool        $raw If true, URL will not be escaped.
4701
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4702
	 *                              If string, will be a custom redirect.
4703
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4704
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4705
	 *
4706
	 * @return string Connect URL
4707
	 */
4708
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4709
		$site_id    = Jetpack_Options::get_option( 'id' );
4710
		$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...
4711
4712
		if ( $register || ! $blog_token || ! $site_id ) {
4713
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4714
4715
			if ( ! empty( $redirect ) ) {
4716
				$url = add_query_arg(
4717
					'redirect',
4718
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4719
					$url
4720
				);
4721
			}
4722
4723
			if ( is_network_admin() ) {
4724
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4725
			}
4726
4727
			$calypso_env = self::get_calypso_env();
4728
4729
			if ( ! empty( $calypso_env ) ) {
4730
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4731
			}
4732
		} else {
4733
4734
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4735
			// because otherwise this logic can get us in to a loop.
4736
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4737
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4738
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4739
4740
				$response = Client::wpcom_json_api_request_as_blog(
4741
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4742
					'1.1'
4743
				);
4744
4745
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4746
4747
					// Generating a register URL instead to refresh the existing token
4748
					return $this->build_connect_url( $raw, $redirect, $from, true );
4749
				}
4750
			}
4751
4752
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4708 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...
4753
		}
4754
4755
		if ( $from ) {
4756
			$url = add_query_arg( 'from', $from, $url );
4757
		}
4758
4759
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4760
		/**
4761
		 * Filter the URL used when connecting a user to a WordPress.com account.
4762
		 *
4763
		 * @since 8.1.0
4764
		 *
4765
		 * @param string $url Connection URL.
4766
		 * @param bool   $raw If true, URL will not be escaped.
4767
		 */
4768
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4769
	}
4770
4771
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4772
4773
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4774
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4775
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4776
4777
		if ( $iframe ) {
4778
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4779
		}
4780
4781
		$c8n = self::connection();
4782
		$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...
4783
4784
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4785
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4786
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4787
4788
		if ( $iframe ) {
4789
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4790
		}
4791
4792
		return $url;
4793
	}
4794
4795
	/**
4796
	 * Filters the connection URL parameter array.
4797
	 *
4798
	 * @param Array $args default URL parameters used by the package.
4799
	 * @return Array the modified URL arguments array.
4800
	 */
4801
	public static function filter_connect_request_body( $args ) {
4802
		if (
4803
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4804
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4805
		) {
4806
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4807
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4808
				? $gp_locale->slug
4809
				: '';
4810
		}
4811
4812
		$tracking        = new Tracking();
4813
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4814
4815
		$args = array_merge(
4816
			$args,
4817
			array(
4818
				'_ui' => $tracks_identity['_ui'],
4819
				'_ut' => $tracks_identity['_ut'],
4820
			)
4821
		);
4822
4823
		$calypso_env = self::get_calypso_env();
4824
4825
		if ( ! empty( $calypso_env ) ) {
4826
			$args['calypso_env'] = $calypso_env;
4827
		}
4828
4829
		return $args;
4830
	}
4831
4832
	/**
4833
	 * Filters the URL that will process the connection data. It can be different from the URL
4834
	 * that we send the user to after everything is done.
4835
	 *
4836
	 * @param String $processing_url the default redirect URL used by the package.
4837
	 * @return String the modified URL.
4838
	 */
4839
	public static function filter_connect_processing_url( $processing_url ) {
4840
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4841
		return $processing_url;
4842
	}
4843
4844
	/**
4845
	 * Filters the redirection URL that is used for connect requests. The redirect
4846
	 * URL should return the user back to the Jetpack console.
4847
	 *
4848
	 * @param String $redirect the default redirect URL used by the package.
4849
	 * @return String the modified URL.
4850
	 */
4851
	public static function filter_connect_redirect_url( $redirect ) {
4852
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4853
		$redirect           = $redirect
4854
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4855
			: $jetpack_admin_page;
4856
4857
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4858
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4859
		}
4860
4861
		return $redirect;
4862
	}
4863
4864
	/**
4865
	 * This action fires at the beginning of the Manager::authorize method.
4866
	 */
4867
	public static function authorize_starting() {
4868
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4869
		// Checking if site has been active/connected previously before recording unique connection.
4870
		if ( ! $jetpack_unique_connection ) {
4871
			// jetpack_unique_connection option has never been set.
4872
			$jetpack_unique_connection = array(
4873
				'connected'    => 0,
4874
				'disconnected' => 0,
4875
				'version'      => '3.6.1',
4876
			);
4877
4878
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4879
4880
			// Track unique connection.
4881
			$jetpack = self::init();
4882
4883
			$jetpack->stat( 'connections', 'unique-connection' );
4884
			$jetpack->do_stats( 'server_side' );
4885
		}
4886
4887
		// Increment number of times connected.
4888
		$jetpack_unique_connection['connected'] += 1;
4889
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4890
	}
4891
4892
	/**
4893
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4894
	 * linked.
4895
	 */
4896
	public static function authorize_ending_linked() {
4897
		// Don't activate anything since we are just connecting a user.
4898
		self::state( 'message', 'linked' );
4899
	}
4900
4901
	/**
4902
	 * This action fires at the end of the Manager::authorize method when the master user is
4903
	 * authorized.
4904
	 *
4905
	 * @param array $data The request data.
4906
	 */
4907
	public static function authorize_ending_authorized( $data ) {
4908
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4909
		self::invalidate_onboarding_token();
4910
4911
		// If redirect_uri is SSO, ensure SSO module is enabled.
4912
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
4913
4914
		/** This filter is documented in class.jetpack-cli.php */
4915
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4916
4917
		$activate_sso = (
4918
			isset( $redirect_options['action'] ) &&
4919
			'jetpack-sso' === $redirect_options['action'] &&
4920
			$jetpack_start_enable_sso
4921
		);
4922
4923
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4924
4925
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4926
	}
4927
4928
	/**
4929
	 * Get our assumed site creation date.
4930
	 * Calculated based on the earlier date of either:
4931
	 * - Earliest admin user registration date.
4932
	 * - Earliest date of post of any post type.
4933
	 *
4934
	 * @since 7.2.0
4935
	 * @deprecated since 7.8.0
4936
	 *
4937
	 * @return string Assumed site creation date and time.
4938
	 */
4939
	public static function get_assumed_site_creation_date() {
4940
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4941
		return self::connection()->get_assumed_site_creation_date();
4942
	}
4943
4944 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4945
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4946
4947
		if ( $activation_source_name ) {
4948
			$args['_as'] = urlencode( $activation_source_name );
4949
		}
4950
4951
		if ( $activation_source_keyword ) {
4952
			$args['_ak'] = urlencode( $activation_source_keyword );
4953
		}
4954
	}
4955
4956
	function build_reconnect_url( $raw = false ) {
4957
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4958
		return $raw ? $url : esc_url( $url );
4959
	}
4960
4961
	public static function admin_url( $args = null ) {
4962
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
0 ignored issues
show
Documentation introduced by
array('page' => 'jetpack') is of type array<string,string,{"page":"string"}>, but the function expects a string.

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...
4963
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4964
		return $url;
4965
	}
4966
4967
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4968
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4969
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4970
	}
4971
4972
	function dismiss_jetpack_notice() {
4973
4974
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4975
			return;
4976
		}
4977
4978
		switch ( $_GET['jetpack-notice'] ) {
4979
			case 'dismiss':
4980
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4981
4982
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4983
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4984
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4985
				}
4986
				break;
4987
		}
4988
	}
4989
4990
	public static function sort_modules( $a, $b ) {
4991
		if ( $a['sort'] == $b['sort'] ) {
4992
			return 0;
4993
		}
4994
4995
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4996
	}
4997
4998
	function ajax_recheck_ssl() {
4999
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5000
		$result = self::permit_ssl( true );
5001
		wp_send_json(
5002
			array(
5003
				'enabled' => $result,
5004
				'message' => get_transient( 'jetpack_https_test_message' ),
5005
			)
5006
		);
5007
	}
5008
5009
	/* Client API */
5010
5011
	/**
5012
	 * Returns the requested Jetpack API URL
5013
	 *
5014
	 * @deprecated since 7.7
5015
	 * @return string
5016
	 */
5017
	public static function api_url( $relative_url ) {
5018
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5019
		$connection = self::connection();
5020
		return $connection->api_url( $relative_url );
5021
	}
5022
5023
	/**
5024
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
5025
	 *
5026
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
5027
	 */
5028
	public static function fix_url_for_bad_hosts( $url ) {
5029
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
5030
		return Connection_Utils::fix_url_for_bad_hosts( $url );
5031
	}
5032
5033
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5034
		// Default to a blog token.
5035
		$token_type = 'blog';
5036
5037
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5038
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5039
			if ( ! empty( $_GET['onboarding'] ) ) {
5040
				$jpo = $_GET;
5041
			} else {
5042
				$jpo = json_decode( $request_data, true );
5043
			}
5044
5045
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5046
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5047
5048
			if (
5049
				isset( $jpo_user )
5050
				&& isset( $jpo_token )
5051
				&& is_email( $jpo_user )
5052
				&& ctype_alnum( $jpo_token )
5053
				&& isset( $_GET['rest_route'] )
5054
				&& self::validate_onboarding_token_action(
5055
					$jpo_token,
5056
					$_GET['rest_route']
5057
				)
5058
			) {
5059
				$jp_user = get_user_by( 'email', $jpo_user );
5060
				if ( is_a( $jp_user, 'WP_User' ) ) {
5061
					wp_set_current_user( $jp_user->ID );
5062
					$user_can = is_multisite()
5063
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5064
						: current_user_can( 'manage_options' );
5065
					if ( $user_can ) {
5066
						$token_type              = 'user';
5067
						$token->external_user_id = $jp_user->ID;
5068
					}
5069
				}
5070
			}
5071
5072
			$token_data['type']    = $token_type;
5073
			$token_data['user_id'] = $token->external_user_id;
5074
		}
5075
5076
		return $token_data;
5077
	}
5078
5079
	/**
5080
	 * Create a random secret for validating onboarding payload
5081
	 *
5082
	 * @return string Secret token
5083
	 */
5084
	public static function create_onboarding_token() {
5085
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5086
			$token = wp_generate_password( 32, false );
5087
			Jetpack_Options::update_option( 'onboarding', $token );
5088
		}
5089
5090
		return $token;
5091
	}
5092
5093
	/**
5094
	 * Remove the onboarding token
5095
	 *
5096
	 * @return bool True on success, false on failure
5097
	 */
5098
	public static function invalidate_onboarding_token() {
5099
		return Jetpack_Options::delete_option( 'onboarding' );
5100
	}
5101
5102
	/**
5103
	 * Validate an onboarding token for a specific action
5104
	 *
5105
	 * @return boolean True if token/action pair is accepted, false if not
5106
	 */
5107
	public static function validate_onboarding_token_action( $token, $action ) {
5108
		// Compare tokens, bail if tokens do not match
5109
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5110
			return false;
5111
		}
5112
5113
		// List of valid actions we can take
5114
		$valid_actions = array(
5115
			'/jetpack/v4/settings',
5116
		);
5117
5118
		// Whitelist the action
5119
		if ( ! in_array( $action, $valid_actions ) ) {
5120
			return false;
5121
		}
5122
5123
		return true;
5124
	}
5125
5126
	/**
5127
	 * Checks to see if the URL is using SSL to connect with Jetpack
5128
	 *
5129
	 * @since 2.3.3
5130
	 * @return boolean
5131
	 */
5132
	public static function permit_ssl( $force_recheck = false ) {
5133
		// Do some fancy tests to see if ssl is being supported
5134
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5135
			$message = '';
5136
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5137
				$ssl = 0;
5138
			} else {
5139
				switch ( JETPACK_CLIENT__HTTPS ) {
5140
					case 'NEVER':
5141
						$ssl     = 0;
5142
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5143
						break;
5144
					case 'ALWAYS':
5145
					case 'AUTO':
5146
					default:
5147
						$ssl = 1;
5148
						break;
5149
				}
5150
5151
				// If it's not 'NEVER', test to see
5152
				if ( $ssl ) {
5153
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5154
						$ssl     = 0;
5155
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5156
					} else {
5157
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5158
						if ( is_wp_error( $response ) ) {
5159
							$ssl     = 0;
5160
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5161
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5162
							$ssl     = 0;
5163
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5164
						}
5165
					}
5166
				}
5167
			}
5168
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5169
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5170
		}
5171
5172
		return (bool) $ssl;
5173
	}
5174
5175
	/*
5176
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5177
	 */
5178
	public function alert_auto_ssl_fail() {
5179
		if ( ! current_user_can( 'manage_options' ) ) {
5180
			return;
5181
		}
5182
5183
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5184
		?>
5185
5186
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5187
			<div class="jp-banner__content">
5188
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5189
				<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>
5190
				<p>
5191
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5192
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5193
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5194
				</p>
5195
				<p>
5196
					<?php
5197
					printf(
5198
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5199
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5200
						esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5201
					);
5202
					?>
5203
				</p>
5204
			</div>
5205
		</div>
5206
		<style>
5207
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5208
		</style>
5209
		<script type="text/javascript">
5210
			jQuery( document ).ready( function( $ ) {
5211
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5212
					var $this = $( this );
5213
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5214
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5215
					e.preventDefault();
5216
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5217
					$.post( ajaxurl, data )
5218
					  .done( function( response ) {
5219
						  if ( response.enabled ) {
5220
							  $( '#jetpack-ssl-warning' ).hide();
5221
						  } else {
5222
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5223
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5224
						  }
5225
					  }.bind( $this ) );
5226
				} );
5227
			} );
5228
		</script>
5229
5230
		<?php
5231
	}
5232
5233
	/**
5234
	 * Returns the Jetpack XML-RPC API
5235
	 *
5236
	 * @deprecated 8.0 Use Connection_Manager instead.
5237
	 * @return string
5238
	 */
5239
	public static function xmlrpc_api_url() {
5240
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5241
		return self::connection()->xmlrpc_api_url();
5242
	}
5243
5244
	/**
5245
	 * Returns the connection manager object.
5246
	 *
5247
	 * @return Automattic\Jetpack\Connection\Manager
5248
	 */
5249
	public static function connection() {
5250
		$jetpack = static::init();
5251
5252
		// If the connection manager hasn't been instantiated, do that now.
5253
		if ( ! $jetpack->connection_manager ) {
5254
			$jetpack->connection_manager = new Connection_Manager();
5255
		}
5256
5257
		return $jetpack->connection_manager;
5258
	}
5259
5260
	/**
5261
	 * Creates two secret tokens and the end of life timestamp for them.
5262
	 *
5263
	 * Note these tokens are unique per call, NOT static per site for connecting.
5264
	 *
5265
	 * @since 2.6
5266
	 * @param String  $action  The action name.
5267
	 * @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...
5268
	 * @param Integer $exp     Expiration time in seconds.
5269
	 * @return array
5270
	 */
5271
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5272
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5273
	}
5274
5275
	public static function get_secrets( $action, $user_id ) {
5276
		$secrets = self::connection()->get_secrets( $action, $user_id );
5277
5278
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5279
			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...
5280
		}
5281
5282
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5283
			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...
5284
		}
5285
5286
		return $secrets;
5287
	}
5288
5289
	/**
5290
	 * @deprecated 7.5 Use Connection_Manager instead.
5291
	 *
5292
	 * @param $action
5293
	 * @param $user_id
5294
	 */
5295
	public static function delete_secrets( $action, $user_id ) {
5296
		return self::connection()->delete_secrets( $action, $user_id );
5297
	}
5298
5299
	/**
5300
	 * Builds the timeout limit for queries talking with the wpcom servers.
5301
	 *
5302
	 * Based on local php max_execution_time in php.ini
5303
	 *
5304
	 * @since 2.6
5305
	 * @return int
5306
	 * @deprecated
5307
	 **/
5308
	public function get_remote_query_timeout_limit() {
5309
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5310
		return self::get_max_execution_time();
5311
	}
5312
5313
	/**
5314
	 * Builds the timeout limit for queries talking with the wpcom servers.
5315
	 *
5316
	 * Based on local php max_execution_time in php.ini
5317
	 *
5318
	 * @since 5.4
5319
	 * @return int
5320
	 **/
5321
	public static function get_max_execution_time() {
5322
		$timeout = (int) ini_get( 'max_execution_time' );
5323
5324
		// Ensure exec time set in php.ini
5325
		if ( ! $timeout ) {
5326
			$timeout = 30;
5327
		}
5328
		return $timeout;
5329
	}
5330
5331
	/**
5332
	 * Sets a minimum request timeout, and returns the current timeout
5333
	 *
5334
	 * @since 5.4
5335
	 **/
5336 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5337
		$timeout = self::get_max_execution_time();
5338
		if ( $timeout < $min_timeout ) {
5339
			$timeout = $min_timeout;
5340
			set_time_limit( $timeout );
5341
		}
5342
		return $timeout;
5343
	}
5344
5345
	/**
5346
	 * Takes the response from the Jetpack register new site endpoint and
5347
	 * verifies it worked properly.
5348
	 *
5349
	 * @since 2.6
5350
	 * @deprecated since 7.7.0
5351
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5352
	 **/
5353
	public function validate_remote_register_response() {
5354
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5355
	}
5356
5357
	/**
5358
	 * @return bool|WP_Error
5359
	 */
5360
	public static function register() {
5361
		$tracking = new Tracking();
5362
		$tracking->record_user_event( 'jpc_register_begin' );
5363
5364
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5365
5366
		$connection   = self::connection();
5367
		$registration = $connection->register();
5368
5369
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5370
5371
		if ( ! $registration || is_wp_error( $registration ) ) {
5372
			return $registration;
5373
		}
5374
5375
		return true;
5376
	}
5377
5378
	/**
5379
	 * Filters the registration request body to include tracking properties.
5380
	 *
5381
	 * @param Array $properties
5382
	 * @return Array amended properties.
5383
	 */
5384 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5385
		$tracking        = new Tracking();
5386
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5387
5388
		return array_merge(
5389
			$properties,
5390
			array(
5391
				'_ui' => $tracks_identity['_ui'],
5392
				'_ut' => $tracks_identity['_ut'],
5393
			)
5394
		);
5395
	}
5396
5397
	/**
5398
	 * Filters the token request body to include tracking properties.
5399
	 *
5400
	 * @param Array $properties
5401
	 * @return Array amended properties.
5402
	 */
5403 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5404
		$tracking        = new Tracking();
5405
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5406
5407
		return array_merge(
5408
			$properties,
5409
			array(
5410
				'_ui' => $tracks_identity['_ui'],
5411
				'_ut' => $tracks_identity['_ut'],
5412
			)
5413
		);
5414
	}
5415
5416
	/**
5417
	 * If the db version is showing something other that what we've got now, bump it to current.
5418
	 *
5419
	 * @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...
5420
	 */
5421
	public static function maybe_set_version_option() {
5422
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5423
		if ( JETPACK__VERSION != $version ) {
5424
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5425
5426
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5427
				/** This action is documented in class.jetpack.php */
5428
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5429
			}
5430
5431
			return true;
5432
		}
5433
		return false;
5434
	}
5435
5436
	/* Client Server API */
5437
5438
	/**
5439
	 * Loads the Jetpack XML-RPC client.
5440
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5441
	 *
5442
	 * @deprecated since 7.7.0
5443
	 */
5444
	public static function load_xml_rpc_client() {
5445
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5446
	}
5447
5448
	/**
5449
	 * Resets the saved authentication state in between testing requests.
5450
	 */
5451
	public function reset_saved_auth_state() {
5452
		$this->rest_authentication_status = null;
5453
5454
		if ( ! $this->connection_manager ) {
5455
			$this->connection_manager = new Connection_Manager();
5456
		}
5457
5458
		$this->connection_manager->reset_saved_auth_state();
5459
	}
5460
5461
	/**
5462
	 * Verifies the signature of the current request.
5463
	 *
5464
	 * @deprecated since 7.7.0
5465
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5466
	 *
5467
	 * @return false|array
5468
	 */
5469
	public function verify_xml_rpc_signature() {
5470
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5471
		return self::connection()->verify_xml_rpc_signature();
5472
	}
5473
5474
	/**
5475
	 * Verifies the signature of the current request.
5476
	 *
5477
	 * This function has side effects and should not be used. Instead,
5478
	 * use the memoized version `->verify_xml_rpc_signature()`.
5479
	 *
5480
	 * @deprecated since 7.7.0
5481
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5482
	 * @internal
5483
	 */
5484
	private function internal_verify_xml_rpc_signature() {
5485
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5486
	}
5487
5488
	/**
5489
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5490
	 *
5491
	 * @deprecated since 7.7.0
5492
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5493
	 *
5494
	 * @param \WP_User|mixed $user     User object if authenticated.
5495
	 * @param string         $username Username.
5496
	 * @param string         $password Password string.
5497
	 * @return \WP_User|mixed Authenticated user or error.
5498
	 */
5499 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5500
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5501
5502
		if ( ! $this->connection_manager ) {
5503
			$this->connection_manager = new Connection_Manager();
5504
		}
5505
5506
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5507
	}
5508
5509
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5510
	// Uses the existing XMLRPC request signing implementation.
5511
	function wp_rest_authenticate( $user ) {
5512
		if ( ! empty( $user ) ) {
5513
			// Another authentication method is in effect.
5514
			return $user;
5515
		}
5516
5517
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5518
			// Nothing to do for this authentication method.
5519
			return null;
5520
		}
5521
5522
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5523
			// Nothing to do for this authentication method.
5524
			return null;
5525
		}
5526
5527
		// Ensure that we always have the request body available.  At this
5528
		// point, the WP REST API code to determine the request body has not
5529
		// run yet.  That code may try to read from 'php://input' later, but
5530
		// this can only be done once per request in PHP versions prior to 5.6.
5531
		// So we will go ahead and perform this read now if needed, and save
5532
		// the request body where both the Jetpack signature verification code
5533
		// and the WP REST API code can see it.
5534
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5535
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5536
		}
5537
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5538
5539
		// Only support specific request parameters that have been tested and
5540
		// are known to work with signature verification.  A different method
5541
		// can be passed to the WP REST API via the '?_method=' parameter if
5542
		// needed.
5543
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5544
			$this->rest_authentication_status = new WP_Error(
5545
				'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...
5546
				__( 'This request method is not supported.', 'jetpack' ),
5547
				array( 'status' => 400 )
5548
			);
5549
			return null;
5550
		}
5551
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5552
			$this->rest_authentication_status = new WP_Error(
5553
				'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...
5554
				__( 'This request method does not support body parameters.', 'jetpack' ),
5555
				array( 'status' => 400 )
5556
			);
5557
			return null;
5558
		}
5559
5560
		if ( ! $this->connection_manager ) {
5561
			$this->connection_manager = new Connection_Manager();
5562
		}
5563
5564
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5565
5566
		if (
5567
			$verified &&
5568
			isset( $verified['type'] ) &&
5569
			'user' === $verified['type'] &&
5570
			! empty( $verified['user_id'] )
5571
		) {
5572
			// Authentication successful.
5573
			$this->rest_authentication_status = true;
5574
			return $verified['user_id'];
5575
		}
5576
5577
		// Something else went wrong.  Probably a signature error.
5578
		$this->rest_authentication_status = new WP_Error(
5579
			'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...
5580
			__( 'The request is not signed correctly.', 'jetpack' ),
5581
			array( 'status' => 400 )
5582
		);
5583
		return null;
5584
	}
5585
5586
	/**
5587
	 * Report authentication status to the WP REST API.
5588
	 *
5589
	 * @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...
5590
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5591
	 */
5592
	public function wp_rest_authentication_errors( $value ) {
5593
		if ( $value !== null ) {
5594
			return $value;
5595
		}
5596
		return $this->rest_authentication_status;
5597
	}
5598
5599
	/**
5600
	 * Add our nonce to this request.
5601
	 *
5602
	 * @deprecated since 7.7.0
5603
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5604
	 *
5605
	 * @param int    $timestamp Timestamp of the request.
5606
	 * @param string $nonce     Nonce string.
5607
	 */
5608 View Code Duplication
	public function add_nonce( $timestamp, $nonce ) {
5609
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5610
5611
		if ( ! $this->connection_manager ) {
5612
			$this->connection_manager = new Connection_Manager();
5613
		}
5614
5615
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5616
	}
5617
5618
	/**
5619
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5620
	 * Capture it here so we can verify the signature later.
5621
	 *
5622
	 * @deprecated since 7.7.0
5623
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5624
	 *
5625
	 * @param array $methods XMLRPC methods.
5626
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5627
	 */
5628 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5629
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5630
5631
		if ( ! $this->connection_manager ) {
5632
			$this->connection_manager = new Connection_Manager();
5633
		}
5634
5635
		return $this->connection_manager->xmlrpc_methods( $methods );
5636
	}
5637
5638
	/**
5639
	 * Register additional public XMLRPC methods.
5640
	 *
5641
	 * @deprecated since 7.7.0
5642
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5643
	 *
5644
	 * @param array $methods Public XMLRPC methods.
5645
	 * @return array Public XMLRPC methods, with the getOptions one.
5646
	 */
5647 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5648
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5649
5650
		if ( ! $this->connection_manager ) {
5651
			$this->connection_manager = new Connection_Manager();
5652
		}
5653
5654
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5655
	}
5656
5657
	/**
5658
	 * Handles a getOptions XMLRPC method call.
5659
	 *
5660
	 * @deprecated since 7.7.0
5661
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5662
	 *
5663
	 * @param array $args method call arguments.
5664
	 * @return array an amended XMLRPC server options array.
5665
	 */
5666 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5667
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5668
5669
		if ( ! $this->connection_manager ) {
5670
			$this->connection_manager = new Connection_Manager();
5671
		}
5672
5673
		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...
5674
	}
5675
5676
	/**
5677
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5678
	 *
5679
	 * @deprecated since 7.7.0
5680
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5681
	 *
5682
	 * @param array $options Standard Core options.
5683
	 * @return array Amended options.
5684
	 */
5685 View Code Duplication
	public function xmlrpc_options( $options ) {
5686
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5687
5688
		if ( ! $this->connection_manager ) {
5689
			$this->connection_manager = new Connection_Manager();
5690
		}
5691
5692
		return $this->connection_manager->xmlrpc_options( $options );
5693
	}
5694
5695
	/**
5696
	 * Cleans nonces that were saved when calling ::add_nonce.
5697
	 *
5698
	 * @deprecated since 7.7.0
5699
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5700
	 *
5701
	 * @param bool $all whether to clean even non-expired nonces.
5702
	 */
5703
	public static function clean_nonces( $all = false ) {
5704
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5705
		return self::connection()->clean_nonces( $all );
5706
	}
5707
5708
	/**
5709
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5710
	 * SET: state( $key, $value );
5711
	 * GET: $value = state( $key );
5712
	 *
5713
	 * @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...
5714
	 * @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...
5715
	 * @param bool   $restate private
5716
	 */
5717
	public static function state( $key = null, $value = null, $restate = false ) {
5718
		static $state = array();
5719
		static $path, $domain;
5720
		if ( ! isset( $path ) ) {
5721
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5722
			$admin_url = self::admin_url();
5723
			$bits      = wp_parse_url( $admin_url );
5724
5725
			if ( is_array( $bits ) ) {
5726
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5727
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5728
			} else {
5729
				$path = $domain = null;
5730
			}
5731
		}
5732
5733
		// Extract state from cookies and delete cookies
5734
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5735
			$yum = $_COOKIE['jetpackState'];
5736
			unset( $_COOKIE['jetpackState'] );
5737
			foreach ( $yum as $k => $v ) {
5738
				if ( strlen( $v ) ) {
5739
					$state[ $k ] = $v;
5740
				}
5741
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5742
			}
5743
		}
5744
5745
		if ( $restate ) {
5746
			foreach ( $state as $k => $v ) {
5747
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5748
			}
5749
			return;
5750
		}
5751
5752
		// Get a state variable
5753
		if ( isset( $key ) && ! isset( $value ) ) {
5754
			if ( array_key_exists( $key, $state ) ) {
5755
				return $state[ $key ];
5756
			}
5757
			return null;
5758
		}
5759
5760
		// Set a state variable
5761
		if ( isset( $key ) && isset( $value ) ) {
5762
			if ( is_array( $value ) && isset( $value[0] ) ) {
5763
				$value = $value[0];
5764
			}
5765
			$state[ $key ] = $value;
5766
			if ( ! headers_sent() ) {
5767
				setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5768
			}
5769
		}
5770
	}
5771
5772
	public static function restate() {
5773
		self::state( null, null, true );
5774
	}
5775
5776
	public static function check_privacy( $file ) {
5777
		static $is_site_publicly_accessible = null;
5778
5779
		if ( is_null( $is_site_publicly_accessible ) ) {
5780
			$is_site_publicly_accessible = false;
5781
5782
			$rpc = new Jetpack_IXR_Client();
5783
5784
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5785
			if ( $success ) {
5786
				$response = $rpc->getResponse();
5787
				if ( $response ) {
5788
					$is_site_publicly_accessible = true;
5789
				}
5790
			}
5791
5792
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5793
		}
5794
5795
		if ( $is_site_publicly_accessible ) {
5796
			return;
5797
		}
5798
5799
		$module_slug = self::get_module_slug( $file );
5800
5801
		$privacy_checks = self::state( 'privacy_checks' );
5802
		if ( ! $privacy_checks ) {
5803
			$privacy_checks = $module_slug;
5804
		} else {
5805
			$privacy_checks .= ",$module_slug";
5806
		}
5807
5808
		self::state( 'privacy_checks', $privacy_checks );
5809
	}
5810
5811
	/**
5812
	 * Helper method for multicall XMLRPC.
5813
	 *
5814
	 * @param ...$args Args for the async_call.
5815
	 */
5816
	public static function xmlrpc_async_call( ...$args ) {
5817
		global $blog_id;
5818
		static $clients = array();
5819
5820
		$client_blog_id = is_multisite() ? $blog_id : 0;
5821
5822
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5823
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5824
			if ( function_exists( 'ignore_user_abort' ) ) {
5825
				ignore_user_abort( true );
5826
			}
5827
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5828
		}
5829
5830
		if ( ! empty( $args[0] ) ) {
5831
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5832
		} elseif ( is_multisite() ) {
5833
			foreach ( $clients as $client_blog_id => $client ) {
5834
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5835
					continue;
5836
				}
5837
5838
				$switch_success = switch_to_blog( $client_blog_id, true );
5839
				if ( ! $switch_success ) {
5840
					continue;
5841
				}
5842
5843
				flush();
5844
				$client->query();
5845
5846
				restore_current_blog();
5847
			}
5848
		} else {
5849
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5850
				flush();
5851
				$clients[0]->query();
5852
			}
5853
		}
5854
	}
5855
5856
	public static function staticize_subdomain( $url ) {
5857
5858
		// Extract hostname from URL
5859
		$host = wp_parse_url( $url, PHP_URL_HOST );
5860
5861
		// Explode hostname on '.'
5862
		$exploded_host = explode( '.', $host );
5863
5864
		// Retrieve the name and TLD
5865
		if ( count( $exploded_host ) > 1 ) {
5866
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5867
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5868
			// Rebuild domain excluding subdomains
5869
			$domain = $name . '.' . $tld;
5870
		} else {
5871
			$domain = $host;
5872
		}
5873
		// Array of Automattic domains
5874
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5875
5876
		// Return $url if not an Automattic domain
5877
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5878
			return $url;
5879
		}
5880
5881
		if ( is_ssl() ) {
5882
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5883
		}
5884
5885
		srand( crc32( basename( $url ) ) );
5886
		$static_counter = rand( 0, 2 );
5887
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5888
5889
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5890
	}
5891
5892
	/* JSON API Authorization */
5893
5894
	/**
5895
	 * Handles the login action for Authorizing the JSON API
5896
	 */
5897
	function login_form_json_api_authorization() {
5898
		$this->verify_json_api_authorization_request();
5899
5900
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5901
5902
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5903
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5904
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5905
	}
5906
5907
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5908
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5909
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5910
			return $url;
5911
		}
5912
5913
		$parsed_url = wp_parse_url( $url );
5914
		$url        = strtok( $url, '?' );
5915
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5916
		if ( ! empty( $parsed_url['query'] ) ) {
5917
			$url .= "&{$parsed_url['query']}";
5918
		}
5919
5920
		return $url;
5921
	}
5922
5923
	// Make sure the POSTed request is handled by the same action
5924
	function preserve_action_in_login_form_for_json_api_authorization() {
5925
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5926
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5927
	}
5928
5929
	// If someone logs in to approve API access, store the Access Code in usermeta
5930
	function store_json_api_authorization_token( $user_login, $user ) {
5931
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5932
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5933
		$token = wp_generate_password( 32, false );
5934
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5935
	}
5936
5937
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5938
	function allow_wpcom_public_api_domain( $domains ) {
5939
		$domains[] = 'public-api.wordpress.com';
5940
		return $domains;
5941
	}
5942
5943
	static function is_redirect_encoded( $redirect_url ) {
5944
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5945
	}
5946
5947
	// Add all wordpress.com environments to the safe redirect whitelist
5948
	function allow_wpcom_environments( $domains ) {
5949
		$domains[] = 'wordpress.com';
5950
		$domains[] = 'wpcalypso.wordpress.com';
5951
		$domains[] = 'horizon.wordpress.com';
5952
		$domains[] = 'calypso.localhost';
5953
		return $domains;
5954
	}
5955
5956
	// Add the Access Code details to the public-api.wordpress.com redirect
5957
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5958
		return add_query_arg(
5959
			urlencode_deep(
5960
				array(
5961
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5962
					'jetpack-user-id' => (int) $user->ID,
5963
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5964
				)
5965
			),
5966
			$redirect_to
5967
		);
5968
	}
5969
5970
5971
	/**
5972
	 * Verifies the request by checking the signature
5973
	 *
5974
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5975
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5976
	 *
5977
	 * @param null|array $environment
5978
	 */
5979
	function verify_json_api_authorization_request( $environment = null ) {
5980
		$environment = is_null( $environment )
5981
			? $_REQUEST
5982
			: $environment;
5983
5984
		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...
5985
		$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...
5986
		if ( ! $token || empty( $token->secret ) ) {
5987
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5988
		}
5989
5990
		$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' );
5991
5992
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5993
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5994
			/**
5995
			 * Jetpack authorisation request Error.
5996
			 *
5997
			 * @since 7.5.0
5998
			 */
5999
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
6000
			$die_error = sprintf(
6001
				/* translators: %s is a URL */
6002
				__( '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' ),
6003
				Redirect::get_url( 'jetpack-support-double-encoding' )
6004
			);
6005
		}
6006
6007
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6008
6009
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6010
			$signature = $jetpack_signature->sign_request(
6011
				$environment['token'],
6012
				$environment['timestamp'],
6013
				$environment['nonce'],
6014
				'',
6015
				'GET',
6016
				$environment['jetpack_json_api_original_query'],
6017
				null,
6018
				true
6019
			);
6020
		} else {
6021
			$signature = $jetpack_signature->sign_current_request(
6022
				array(
6023
					'body'   => null,
6024
					'method' => 'GET',
6025
				)
6026
			);
6027
		}
6028
6029
		if ( ! $signature ) {
6030
			wp_die( $die_error );
6031
		} elseif ( is_wp_error( $signature ) ) {
6032
			wp_die( $die_error );
6033
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
6034
			if ( is_ssl() ) {
6035
				// 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
6036
				$signature = $jetpack_signature->sign_current_request(
6037
					array(
6038
						'scheme' => 'http',
6039
						'body'   => null,
6040
						'method' => 'GET',
6041
					)
6042
				);
6043
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6044
					wp_die( $die_error );
6045
				}
6046
			} else {
6047
				wp_die( $die_error );
6048
			}
6049
		}
6050
6051
		$timestamp = (int) $environment['timestamp'];
6052
		$nonce     = stripslashes( (string) $environment['nonce'] );
6053
6054
		if ( ! $this->connection_manager ) {
6055
			$this->connection_manager = new Connection_Manager();
6056
		}
6057
6058
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
6059
			// De-nonce the nonce, at least for 5 minutes.
6060
			// 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)
6061
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6062
			if ( $old_nonce_time < time() - 300 ) {
6063
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6064
			}
6065
		}
6066
6067
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6068
		$data_filters = array(
6069
			'state'        => 'opaque',
6070
			'client_id'    => 'int',
6071
			'client_title' => 'string',
6072
			'client_image' => 'url',
6073
		);
6074
6075
		foreach ( $data_filters as $key => $sanitation ) {
6076
			if ( ! isset( $data->$key ) ) {
6077
				wp_die( $die_error );
6078
			}
6079
6080
			switch ( $sanitation ) {
6081
				case 'int':
6082
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6083
					break;
6084
				case 'opaque':
6085
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6086
					break;
6087
				case 'string':
6088
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6089
					break;
6090
				case 'url':
6091
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6092
					break;
6093
			}
6094
		}
6095
6096
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6097
			wp_die( $die_error );
6098
		}
6099
	}
6100
6101
	function login_message_json_api_authorization( $message ) {
6102
		return '<p class="message">' . sprintf(
6103
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6104
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6105
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6106
	}
6107
6108
	/**
6109
	 * Get $content_width, but with a <s>twist</s> filter.
6110
	 */
6111
	public static function get_content_width() {
6112
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6113
			? $GLOBALS['content_width']
6114
			: false;
6115
		/**
6116
		 * Filter the Content Width value.
6117
		 *
6118
		 * @since 2.2.3
6119
		 *
6120
		 * @param string $content_width Content Width value.
6121
		 */
6122
		return apply_filters( 'jetpack_content_width', $content_width );
6123
	}
6124
6125
	/**
6126
	 * Pings the WordPress.com Mirror Site for the specified options.
6127
	 *
6128
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6129
	 *
6130
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6131
	 */
6132
	public function get_cloud_site_options( $option_names ) {
6133
		$option_names = array_filter( (array) $option_names, 'is_string' );
6134
6135
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
6136
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6137
		if ( $xml->isError() ) {
6138
			return array(
6139
				'error_code' => $xml->getErrorCode(),
6140
				'error_msg'  => $xml->getErrorMessage(),
6141
			);
6142
		}
6143
		$cloud_site_options = $xml->getResponse();
6144
6145
		return $cloud_site_options;
6146
	}
6147
6148
	/**
6149
	 * Checks if the site is currently in an identity crisis.
6150
	 *
6151
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6152
	 */
6153
	public static function check_identity_crisis() {
6154
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6155
			return false;
6156
		}
6157
6158
		return Jetpack_Options::get_option( 'sync_error_idc' );
6159
	}
6160
6161
	/**
6162
	 * Checks whether the home and siteurl specifically are whitelisted
6163
	 * Written so that we don't have re-check $key and $value params every time
6164
	 * we want to check if this site is whitelisted, for example in footer.php
6165
	 *
6166
	 * @since  3.8.0
6167
	 * @return bool True = already whitelisted False = not whitelisted
6168
	 */
6169
	public static function is_staging_site() {
6170
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6171
		return ( new Status() )->is_staging_site();
6172
	}
6173
6174
	/**
6175
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6176
	 *
6177
	 * @since 4.4.0
6178
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6179
	 *
6180
	 * @return bool
6181
	 */
6182
	public static function validate_sync_error_idc_option() {
6183
		$is_valid = false;
6184
6185
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6186
		if ( false === $idc_allowed ) {
6187
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6188
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6189
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6190
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6191
				$transient_duration = HOUR_IN_SECONDS;
6192
			} else {
6193
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6194
				$idc_allowed        = '1';
6195
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6196
			}
6197
6198
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6199
		}
6200
6201
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6202
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6203
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6204
			$local_options = self::get_sync_error_idc_option();
6205
			// Ensure all values are set.
6206
			if ( isset( $sync_error['home'] ) && isset ( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6207
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6208
					$is_valid = true;
6209
				}
6210
			}
6211
6212
		}
6213
6214
		/**
6215
		 * Filters whether the sync_error_idc option is valid.
6216
		 *
6217
		 * @since 4.4.0
6218
		 *
6219
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6220
		 */
6221
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6222
6223
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6224
			// Since the option exists, and did not validate, delete it
6225
			Jetpack_Options::delete_option( 'sync_error_idc' );
6226
		}
6227
6228
		return $is_valid;
6229
	}
6230
6231
	/**
6232
	 * Normalizes a url by doing three things:
6233
	 *  - Strips protocol
6234
	 *  - Strips www
6235
	 *  - Adds a trailing slash
6236
	 *
6237
	 * @since 4.4.0
6238
	 * @param string $url
6239
	 * @return WP_Error|string
6240
	 */
6241
	public static function normalize_url_protocol_agnostic( $url ) {
6242
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6243
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6244
			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...
6245
		}
6246
6247
		// Strip www and protocols
6248
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6249
		return $url;
6250
	}
6251
6252
	/**
6253
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6254
	 *
6255
	 * @since 4.4.0
6256
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6257
	 *
6258
	 * @param array $response
6259
	 * @return array Array of the local urls, wpcom urls, and error code
6260
	 */
6261
	public static function get_sync_error_idc_option( $response = array() ) {
6262
		// Since the local options will hit the database directly, store the values
6263
		// in a transient to allow for autoloading and caching on subsequent views.
6264
		$local_options = get_transient( 'jetpack_idc_local' );
6265
		if ( false === $local_options ) {
6266
			$local_options = array(
6267
				'home'    => Functions::home_url(),
6268
				'siteurl' => Functions::site_url(),
6269
			);
6270
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6271
		}
6272
6273
		$options = array_merge( $local_options, $response );
6274
6275
		$returned_values = array();
6276
		foreach ( $options as $key => $option ) {
6277
			if ( 'error_code' === $key ) {
6278
				$returned_values[ $key ] = $option;
6279
				continue;
6280
			}
6281
6282
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6283
				continue;
6284
			}
6285
6286
			$returned_values[ $key ] = $normalized_url;
6287
		}
6288
6289
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6290
6291
		return $returned_values;
6292
	}
6293
6294
	/**
6295
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6296
	 * If set to true, the site will be put into staging mode.
6297
	 *
6298
	 * @since 4.3.2
6299
	 * @return bool
6300
	 */
6301
	public static function sync_idc_optin() {
6302
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6303
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6304
		} else {
6305
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6306
		}
6307
6308
		/**
6309
		 * Allows sites to opt in to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6310
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6311
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6312
		 *
6313
		 * @since 4.3.2
6314
		 *
6315
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6316
		 */
6317
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6318
	}
6319
6320
	/**
6321
	 * Maybe Use a .min.css stylesheet, maybe not.
6322
	 *
6323
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6324
	 */
6325
	public static function maybe_min_asset( $url, $path, $plugin ) {
6326
		// Short out on things trying to find actual paths.
6327
		if ( ! $path || empty( $plugin ) ) {
6328
			return $url;
6329
		}
6330
6331
		$path = ltrim( $path, '/' );
6332
6333
		// Strip out the abspath.
6334
		$base = dirname( plugin_basename( $plugin ) );
6335
6336
		// Short out on non-Jetpack assets.
6337
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6338
			return $url;
6339
		}
6340
6341
		// File name parsing.
6342
		$file              = "{$base}/{$path}";
6343
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6344
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6345
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6346
		$extension         = array_shift( $file_name_parts_r );
6347
6348
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6349
			// Already pointing at the minified version.
6350
			if ( 'min' === $file_name_parts_r[0] ) {
6351
				return $url;
6352
			}
6353
6354
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6355
			if ( file_exists( $min_full_path ) ) {
6356
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6357
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6358
				if ( 'css' === $extension ) {
6359
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6360
					self::$min_assets[ $key ] = $path;
6361
				}
6362
			}
6363
		}
6364
6365
		return $url;
6366
	}
6367
6368
	/**
6369
	 * If the asset is minified, let's flag .min as the suffix.
6370
	 *
6371
	 * Attached to `style_loader_src` filter.
6372
	 *
6373
	 * @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...
6374
	 * @param string $handle The registered handle of the script in question.
6375
	 * @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...
6376
	 */
6377
	public static function set_suffix_on_min( $src, $handle ) {
6378
		if ( false === strpos( $src, '.min.css' ) ) {
6379
			return $src;
6380
		}
6381
6382
		if ( ! empty( self::$min_assets ) ) {
6383
			foreach ( self::$min_assets as $file => $path ) {
6384
				if ( false !== strpos( $src, $file ) ) {
6385
					wp_style_add_data( $handle, 'suffix', '.min' );
6386
					return $src;
6387
				}
6388
			}
6389
		}
6390
6391
		return $src;
6392
	}
6393
6394
	/**
6395
	 * Maybe inlines a stylesheet.
6396
	 *
6397
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6398
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6399
	 *
6400
	 * Attached to `style_loader_tag` filter.
6401
	 *
6402
	 * @param string $tag The tag that would link to the external asset.
6403
	 * @param string $handle The registered handle of the script in question.
6404
	 *
6405
	 * @return string
6406
	 */
6407
	public static function maybe_inline_style( $tag, $handle ) {
6408
		global $wp_styles;
6409
		$item = $wp_styles->registered[ $handle ];
6410
6411
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6412
			return $tag;
6413
		}
6414
6415
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6416
			$href = $matches[1];
6417
			// Strip off query string
6418
			if ( $pos = strpos( $href, '?' ) ) {
6419
				$href = substr( $href, 0, $pos );
6420
			}
6421
			// Strip off fragment
6422
			if ( $pos = strpos( $href, '#' ) ) {
6423
				$href = substr( $href, 0, $pos );
6424
			}
6425
		} else {
6426
			return $tag;
6427
		}
6428
6429
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6430
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6431
			return $tag;
6432
		}
6433
6434
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6435
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6436
			// And this isn't the pass that actually deals with the RTL version...
6437
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6438
				// Short out, as the RTL version will deal with it in a moment.
6439
				return $tag;
6440
			}
6441
		}
6442
6443
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6444
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6445
		if ( $css ) {
6446
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6447
			if ( empty( $item->extra['after'] ) ) {
6448
				wp_add_inline_style( $handle, $css );
6449
			} else {
6450
				array_unshift( $item->extra['after'], $css );
6451
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6452
			}
6453
		}
6454
6455
		return $tag;
6456
	}
6457
6458
	/**
6459
	 * Loads a view file from the views
6460
	 *
6461
	 * Data passed in with the $data parameter will be available in the
6462
	 * template file as $data['value']
6463
	 *
6464
	 * @param string $template - Template file to load
6465
	 * @param array  $data - Any data to pass along to the template
6466
	 * @return boolean - If template file was found
6467
	 **/
6468
	public function load_view( $template, $data = array() ) {
6469
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6470
6471
		if ( file_exists( $views_dir . $template ) ) {
6472
			require_once $views_dir . $template;
6473
			return true;
6474
		}
6475
6476
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6477
		return false;
6478
	}
6479
6480
	/**
6481
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6482
	 */
6483
	public function deprecated_hooks() {
6484
		global $wp_filter;
6485
6486
		/*
6487
		 * Format:
6488
		 * deprecated_filter_name => replacement_name
6489
		 *
6490
		 * If there is no replacement, use null for replacement_name
6491
		 */
6492
		$deprecated_list = array(
6493
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6494
			'wpl_sharing_2014_1'                           => null,
6495
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6496
			'jetpack_identity_crisis_options_to_check'     => null,
6497
			'update_option_jetpack_single_user_site'       => null,
6498
			'audio_player_default_colors'                  => null,
6499
			'add_option_jetpack_featured_images_enabled'   => null,
6500
			'add_option_jetpack_update_details'            => null,
6501
			'add_option_jetpack_updates'                   => null,
6502
			'add_option_jetpack_network_name'              => null,
6503
			'add_option_jetpack_network_allow_new_registrations' => null,
6504
			'add_option_jetpack_network_add_new_users'     => null,
6505
			'add_option_jetpack_network_site_upload_space' => null,
6506
			'add_option_jetpack_network_upload_file_types' => null,
6507
			'add_option_jetpack_network_enable_administration_menus' => null,
6508
			'add_option_jetpack_is_multi_site'             => null,
6509
			'add_option_jetpack_is_main_network'           => null,
6510
			'add_option_jetpack_main_network_site'         => null,
6511
			'jetpack_sync_all_registered_options'          => null,
6512
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6513
			'jetpack_is_post_mailable'                     => null,
6514
			'jetpack_seo_site_host'                        => null,
6515
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6516
			'jetpack_holiday_snow_option_name'             => null,
6517
			'jetpack_holiday_chance_of_snow'               => null,
6518
			'jetpack_holiday_snow_js_url'                  => null,
6519
			'jetpack_is_holiday_snow_season'               => null,
6520
			'jetpack_holiday_snow_option_updated'          => null,
6521
			'jetpack_holiday_snowing'                      => null,
6522
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6523
			'jetpack_cache_plans'                          => null,
6524
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6525
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6526
			'jetpack_enable_site_verification'             => null,
6527
			'can_display_jetpack_manage_notice'            => null,
6528
			// Removed in Jetpack 7.3.0
6529
			'atd_load_scripts'                             => null,
6530
			'atd_http_post_timeout'                        => null,
6531
			'atd_http_post_error'                          => null,
6532
			'atd_service_domain'                           => null,
6533
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6534
			// Removed in Jetpack 7.9.0
6535
			'jetpack_pwa_manifest'                         => null,
6536
			'jetpack_pwa_background_color'                 => null,
6537
			// Removed in Jetpack 8.3.0.
6538
			'jetpack_check_mobile'                         => null,
6539
			'jetpack_mobile_stylesheet'                    => null,
6540
			'jetpack_mobile_template'                      => null,
6541
			'mobile_reject_mobile'                         => null,
6542
			'mobile_force_mobile'                          => null,
6543
			'mobile_app_promo_download'                    => null,
6544
			'mobile_setup'                                 => null,
6545
			'jetpack_mobile_footer_before'                 => null,
6546
			'wp_mobile_theme_footer'                       => null,
6547
			'minileven_credits'                            => null,
6548
			'jetpack_mobile_header_before'                 => null,
6549
			'jetpack_mobile_header_after'                  => null,
6550
			'jetpack_mobile_theme_menu'                    => null,
6551
			'minileven_show_featured_images'               => null,
6552
			'minileven_attachment_size'                    => null,
6553
		);
6554
6555
		// This is a silly loop depth. Better way?
6556
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6557
			if ( has_action( $hook ) ) {
6558
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6559
					foreach ( $values as $hooked ) {
6560
						if ( is_callable( $hooked['function'] ) ) {
6561
							$function_name = $hooked['function'];
6562
						} else {
6563
							$function_name = 'an anonymous function';
6564
						}
6565
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6566
					}
6567
				}
6568
			}
6569
		}
6570
	}
6571
6572
	/**
6573
	 * Converts any url in a stylesheet, to the correct absolute url.
6574
	 *
6575
	 * Considerations:
6576
	 *  - Normal, relative URLs     `feh.png`
6577
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6578
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6579
	 *  - Absolute URLs             `http://domain.com/feh.png`
6580
	 *  - Domain root relative URLs `/feh.png`
6581
	 *
6582
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6583
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6584
	 *
6585
	 * @return mixed|string
6586
	 */
6587
	public static function absolutize_css_urls( $css, $css_file_url ) {
6588
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6589
		$css_dir = dirname( $css_file_url );
6590
		$p       = wp_parse_url( $css_dir );
6591
		$domain  = sprintf(
6592
			'%1$s//%2$s%3$s%4$s',
6593
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6594
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6595
			$p['host'],
6596
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6597
		);
6598
6599
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6600
			$find = $replace = array();
6601
			foreach ( $matches as $match ) {
6602
				$url = trim( $match['path'], "'\" \t" );
6603
6604
				// If this is a data url, we don't want to mess with it.
6605
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6606
					continue;
6607
				}
6608
6609
				// If this is an absolute or protocol-agnostic url,
6610
				// we don't want to mess with it.
6611
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6612
					continue;
6613
				}
6614
6615
				switch ( substr( $url, 0, 1 ) ) {
6616
					case '/':
6617
						$absolute = $domain . $url;
6618
						break;
6619
					default:
6620
						$absolute = $css_dir . '/' . $url;
6621
				}
6622
6623
				$find[]    = $match[0];
6624
				$replace[] = sprintf( 'url("%s")', $absolute );
6625
			}
6626
			$css = str_replace( $find, $replace, $css );
6627
		}
6628
6629
		return $css;
6630
	}
6631
6632
	/**
6633
	 * This methods removes all of the registered css files on the front end
6634
	 * from Jetpack in favor of using a single file. In effect "imploding"
6635
	 * all the files into one file.
6636
	 *
6637
	 * Pros:
6638
	 * - Uses only ONE css asset connection instead of 15
6639
	 * - Saves a minimum of 56k
6640
	 * - Reduces server load
6641
	 * - Reduces time to first painted byte
6642
	 *
6643
	 * Cons:
6644
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6645
	 *      should not cause any issues with themes.
6646
	 * - Plugins/themes dequeuing styles no longer do anything. See
6647
	 *      jetpack_implode_frontend_css filter for a workaround
6648
	 *
6649
	 * For some situations developers may wish to disable css imploding and
6650
	 * instead operate in legacy mode where each file loads seperately and
6651
	 * can be edited individually or dequeued. This can be accomplished with
6652
	 * the following line:
6653
	 *
6654
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6655
	 *
6656
	 * @since 3.2
6657
	 **/
6658
	public function implode_frontend_css( $travis_test = false ) {
6659
		$do_implode = true;
6660
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6661
			$do_implode = false;
6662
		}
6663
6664
		// Do not implode CSS when the page loads via the AMP plugin.
6665
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6666
			$do_implode = false;
6667
		}
6668
6669
		/**
6670
		 * Allow CSS to be concatenated into a single jetpack.css file.
6671
		 *
6672
		 * @since 3.2.0
6673
		 *
6674
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6675
		 */
6676
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6677
6678
		// Do not use the imploded file when default behavior was altered through the filter
6679
		if ( ! $do_implode ) {
6680
			return;
6681
		}
6682
6683
		// We do not want to use the imploded file in dev mode, or if not connected
6684
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6685
			if ( ! $travis_test ) {
6686
				return;
6687
			}
6688
		}
6689
6690
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6691
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6692
			return;
6693
		}
6694
6695
		/*
6696
		 * Now we assume Jetpack is connected and able to serve the single
6697
		 * file.
6698
		 *
6699
		 * In the future there will be a check here to serve the file locally
6700
		 * or potentially from the Jetpack CDN
6701
		 *
6702
		 * For now:
6703
		 * - Enqueue a single imploded css file
6704
		 * - Zero out the style_loader_tag for the bundled ones
6705
		 * - Be happy, drink scotch
6706
		 */
6707
6708
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6709
6710
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6711
6712
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6713
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6714
	}
6715
6716
	function concat_remove_style_loader_tag( $tag, $handle ) {
6717
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6718
			$tag = '';
6719
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6720
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6721
			}
6722
		}
6723
6724
		return $tag;
6725
	}
6726
6727
	/**
6728
	 * Add an async attribute to scripts that can be loaded asynchronously.
6729
	 * https://www.w3schools.com/tags/att_script_async.asp
6730
	 *
6731
	 * @since 7.7.0
6732
	 *
6733
	 * @param string $tag    The <script> tag for the enqueued script.
6734
	 * @param string $handle The script's registered handle.
6735
	 * @param string $src    The script's source URL.
6736
	 */
6737
	public function script_add_async( $tag, $handle, $src ) {
6738
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6739
			return preg_replace( '/^<script /i', '<script async ', $tag );
6740
		}
6741
6742
		return $tag;
6743
	}
6744
6745
	/*
6746
	 * Check the heartbeat data
6747
	 *
6748
	 * Organizes the heartbeat data by severity.  For example, if the site
6749
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6750
	 *
6751
	 * Data will be added to "caution" array, if it either:
6752
	 *  - Out of date Jetpack version
6753
	 *  - Out of date WP version
6754
	 *  - Out of date PHP version
6755
	 *
6756
	 * $return array $filtered_data
6757
	 */
6758
	public static function jetpack_check_heartbeat_data() {
6759
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6760
6761
		$good    = array();
6762
		$caution = array();
6763
		$bad     = array();
6764
6765
		foreach ( $raw_data as $stat => $value ) {
6766
6767
			// Check jetpack version
6768
			if ( 'version' == $stat ) {
6769
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6770
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6771
					continue;
6772
				}
6773
			}
6774
6775
			// Check WP version
6776
			if ( 'wp-version' == $stat ) {
6777
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6778
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6779
					continue;
6780
				}
6781
			}
6782
6783
			// Check PHP version
6784
			if ( 'php-version' == $stat ) {
6785
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6786
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_PHP_VERSION;
6787
					continue;
6788
				}
6789
			}
6790
6791
			// Check ID crisis
6792
			if ( 'identitycrisis' == $stat ) {
6793
				if ( 'yes' == $value ) {
6794
					$bad[ $stat ] = $value;
6795
					continue;
6796
				}
6797
			}
6798
6799
			// The rest are good :)
6800
			$good[ $stat ] = $value;
6801
		}
6802
6803
		$filtered_data = array(
6804
			'good'    => $good,
6805
			'caution' => $caution,
6806
			'bad'     => $bad,
6807
		);
6808
6809
		return $filtered_data;
6810
	}
6811
6812
6813
	/*
6814
	 * This method is used to organize all options that can be reset
6815
	 * without disconnecting Jetpack.
6816
	 *
6817
	 * It is used in class.jetpack-cli.php to reset options
6818
	 *
6819
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6820
	 *
6821
	 * @return array of options to delete.
6822
	 */
6823
	public static function get_jetpack_options_for_reset() {
6824
		return Jetpack_Options::get_options_for_reset();
6825
	}
6826
6827
	/*
6828
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6829
	 * so we can bring them directly to their site in calypso.
6830
	 *
6831
	 * @param string | url
6832
	 * @return string | url without the guff
6833
	 */
6834 View Code Duplication
	public static function build_raw_urls( $url ) {
6835
		$strip_http = '/.*?:\/\//i';
6836
		$url        = preg_replace( $strip_http, '', $url );
6837
		$url        = str_replace( '/', '::', $url );
6838
		return $url;
6839
	}
6840
6841
	/**
6842
	 * Stores and prints out domains to prefetch for page speed optimization.
6843
	 *
6844
	 * @param mixed $new_urls
6845
	 */
6846
	public static function dns_prefetch( $new_urls = null ) {
6847
		static $prefetch_urls = array();
6848
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6849
			echo "\r\n";
6850
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6851
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6852
			}
6853
		} elseif ( ! empty( $new_urls ) ) {
6854
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6855
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6856
			}
6857
			foreach ( (array) $new_urls as $this_new_url ) {
6858
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6859
			}
6860
			$prefetch_urls = array_unique( $prefetch_urls );
6861
		}
6862
	}
6863
6864
	public function wp_dashboard_setup() {
6865
		if ( self::is_active() ) {
6866
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6867
		}
6868
6869
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6870
			$jetpack_logo = new Jetpack_Logo();
6871
			$widget_title = sprintf(
6872
				wp_kses(
6873
					/* translators: Placeholder is a Jetpack logo. */
6874
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6875
					array( 'span' => array() )
6876
				),
6877
				$jetpack_logo->get_jp_emblem( true )
6878
			);
6879
6880
			wp_add_dashboard_widget(
6881
				'jetpack_summary_widget',
6882
				$widget_title,
6883
				array( __CLASS__, 'dashboard_widget' )
6884
			);
6885
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6886
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6887
6888
			// If we're inactive and not in development mode, sort our box to the top.
6889
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6890
				global $wp_meta_boxes;
6891
6892
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6893
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6894
6895
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6896
			}
6897
		}
6898
	}
6899
6900
	/**
6901
	 * @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...
6902
	 * @return mixed
6903
	 */
6904
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6905
		if ( ! is_array( $sorted ) ) {
6906
			return $sorted;
6907
		}
6908
6909
		foreach ( $sorted as $box_context => $ids ) {
6910
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6911
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6912
				continue;
6913
			}
6914
6915
			$ids_array = explode( ',', $ids );
6916
			$key       = array_search( 'dashboard_stats', $ids_array );
6917
6918
			if ( false !== $key ) {
6919
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6920
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6921
				$sorted[ $box_context ] = implode( ',', $ids_array );
6922
				// We've found it, stop searching, and just return.
6923
				break;
6924
			}
6925
		}
6926
6927
		return $sorted;
6928
	}
6929
6930
	public static function dashboard_widget() {
6931
		/**
6932
		 * Fires when the dashboard is loaded.
6933
		 *
6934
		 * @since 3.4.0
6935
		 */
6936
		do_action( 'jetpack_dashboard_widget' );
6937
	}
6938
6939
	public static function dashboard_widget_footer() {
6940
		?>
6941
		<footer>
6942
6943
		<div class="protect">
6944
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
6945
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6946
				<p class="blocked-count">
6947
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
6948
				</p>
6949
				<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>
6950
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
6951
				<a href="
6952
				<?php
6953
				echo esc_url(
6954
					wp_nonce_url(
6955
						self::admin_url(
6956
							array(
6957
								'action' => 'activate',
6958
								'module' => 'protect',
6959
							)
6960
						),
6961
						'jetpack_activate-protect'
6962
					)
6963
				);
6964
				?>
6965
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6966
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
6967
				</a>
6968
			<?php else : ?>
6969
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
6970
			<?php endif; ?>
6971
		</div>
6972
6973
		<div class="akismet">
6974
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
6975
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6976
				<p class="blocked-count">
6977
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
6978
				</p>
6979
				<p><?php echo esc_html_x( 'Blocked spam comments.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6980
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6981
				<a href="
6982
				<?php
6983
				echo esc_url(
6984
					wp_nonce_url(
6985
						add_query_arg(
6986
							array(
6987
								'action' => 'activate',
6988
								'plugin' => 'akismet/akismet.php',
6989
							),
6990
							admin_url( 'plugins.php' )
6991
						),
6992
						'activate-plugin_akismet/akismet.php'
6993
					)
6994
				);
6995
				?>
6996
							" class="button button-jetpack">
6997
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
6998
				</a>
6999
			<?php else : ?>
7000
				<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( 'Anti-spam can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
7001
			<?php endif; ?>
7002
		</div>
7003
7004
		</footer>
7005
		<?php
7006
	}
7007
7008
	/*
7009
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7010
	 */
7011
	function jetpack_icon_user_connected( $columns ) {
7012
		$columns['user_jetpack'] = '';
7013
		return $columns;
7014
	}
7015
7016
	/*
7017
	 * Show Jetpack icon if the user is linked.
7018
	 */
7019
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7020
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
7021
			$jetpack_logo = new Jetpack_Logo();
7022
			$emblem_html  = sprintf(
7023
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7024
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7025
				$jetpack_logo->get_jp_emblem()
7026
			);
7027
			return $emblem_html;
7028
		}
7029
7030
		return $val;
7031
	}
7032
7033
	/*
7034
	 * Style the Jetpack user column
7035
	 */
7036
	function jetpack_user_col_style() {
7037
		global $current_screen;
7038
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7039
			?>
7040
			<style>
7041
				.fixed .column-user_jetpack {
7042
					width: 21px;
7043
				}
7044
				.jp-emblem-user-admin svg {
7045
					width: 20px;
7046
					height: 20px;
7047
				}
7048
				.jp-emblem-user-admin path {
7049
					fill: #00BE28;
7050
				}
7051
			</style>
7052
			<?php
7053
		}
7054
	}
7055
7056
	/**
7057
	 * Checks if Akismet is active and working.
7058
	 *
7059
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7060
	 * that implied usage of methods present since more recent version.
7061
	 * See https://github.com/Automattic/jetpack/pull/9585
7062
	 *
7063
	 * @since  5.1.0
7064
	 *
7065
	 * @return bool True = Akismet available. False = Aksimet not available.
7066
	 */
7067
	public static function is_akismet_active() {
7068
		static $status = null;
7069
7070
		if ( ! is_null( $status ) ) {
7071
			return $status;
7072
		}
7073
7074
		// Check if a modern version of Akismet is active.
7075
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7076
			$status = false;
7077
			return $status;
7078
		}
7079
7080
		// Make sure there is a key known to Akismet at all before verifying key.
7081
		$akismet_key = Akismet::get_api_key();
7082
		if ( ! $akismet_key ) {
7083
			$status = false;
7084
			return $status;
7085
		}
7086
7087
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7088
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7089
7090
		// 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.
7091
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7092
		// We cache the result of the Akismet key verification for ten minutes.
7093
		if ( ! $akismet_key_state || $recheck ) {
7094
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7095
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7096
		}
7097
7098
		$status = 'valid' === $akismet_key_state;
7099
7100
		return $status;
7101
	}
7102
7103
	/**
7104
	 * @deprecated
7105
	 *
7106
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7107
	 */
7108
	public static function is_function_in_backtrace() {
7109
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7110
	}
7111
7112
	/**
7113
	 * Given a minified path, and a non-minified path, will return
7114
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7115
	 *
7116
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7117
	 * root Jetpack directory.
7118
	 *
7119
	 * @since 5.6.0
7120
	 *
7121
	 * @param string $min_path
7122
	 * @param string $non_min_path
7123
	 * @return string The URL to the file
7124
	 */
7125
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7126
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7127
	}
7128
7129
	/**
7130
	 * Checks for whether Jetpack Backup & Scan is enabled.
7131
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
7132
	 *
7133
	 * @return bool|int|mixed
7134
	 */
7135
	public static function is_rewind_enabled() {
7136
		if ( ! self::is_active() ) {
7137
			return false;
7138
		}
7139
7140
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7141
		if ( false === $rewind_enabled ) {
7142
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7143
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7144
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7145
				&& ! empty( $rewind_data['state'] )
7146
				&& 'active' === $rewind_data['state'] )
7147
				? 1
7148
				: 0;
7149
7150
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7151
		}
7152
		return $rewind_enabled;
7153
	}
7154
7155
	/**
7156
	 * Return Calypso environment value; used for developing Jetpack and pairing
7157
	 * it with different Calypso enrionments, such as localhost.
7158
	 *
7159
	 * @since 7.4.0
7160
	 *
7161
	 * @return string Calypso environment
7162
	 */
7163
	public static function get_calypso_env() {
7164
		if ( isset( $_GET['calypso_env'] ) ) {
7165
			return sanitize_key( $_GET['calypso_env'] );
7166
		}
7167
7168
		if ( getenv( 'CALYPSO_ENV' ) ) {
7169
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7170
		}
7171
7172
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7173
			return sanitize_key( CALYPSO_ENV );
7174
		}
7175
7176
		return '';
7177
	}
7178
7179
	/**
7180
	 * Returns the hostname with protocol for Calypso.
7181
	 * Used for developing Jetpack with Calypso.
7182
	 *
7183
	 * @since 8.4.0
7184
	 *
7185
	 * @return string Calypso host.
7186
	 */
7187
	public static function get_calypso_host() {
7188
		$calypso_env = self::get_calypso_env();
7189
		switch ( $calypso_env ) {
7190
			case 'development':
7191
				return 'http://calypso.localhost:3000/';
7192
			case 'wpcalypso':
7193
				return 'https://wpcalypso.wordpress.com/';
7194
			case 'horizon':
7195
				return 'https://horizon.wordpress.com/';
7196
			default:
7197
				return 'https://wordpress.com/';
7198
		}
7199
	}
7200
7201
	/**
7202
	 * Checks whether or not TOS has been agreed upon.
7203
	 * Will return true if a user has clicked to register, or is already connected.
7204
	 */
7205
	public static function jetpack_tos_agreed() {
7206
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7207
7208
		$terms_of_service = new Terms_Of_Service();
7209
		return $terms_of_service->has_agreed();
7210
7211
	}
7212
7213
	/**
7214
	 * Handles activating default modules as well general cleanup for the new connection.
7215
	 *
7216
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7217
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7218
	 * @param boolean $send_state_messages          Whether to send state messages.
7219
	 * @return void
7220
	 */
7221
	public static function handle_post_authorization_actions(
7222
		$activate_sso = false,
7223
		$redirect_on_activation_error = false,
7224
		$send_state_messages = true
7225
	) {
7226
		$other_modules = $activate_sso
7227
			? array( 'sso' )
7228
			: array();
7229
7230
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7231
			self::delete_active_modules();
7232
7233
			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...
7234
		} else {
7235
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7236
		}
7237
7238
		// Since this is a fresh connection, be sure to clear out IDC options
7239
		Jetpack_IDC::clear_all_idc_options();
7240
7241
		if ( $send_state_messages ) {
7242
			self::state( 'message', 'authorized' );
7243
		}
7244
	}
7245
7246
	/**
7247
	 * Returns a boolean for whether backups UI should be displayed or not.
7248
	 *
7249
	 * @return bool Should backups UI be displayed?
7250
	 */
7251
	public static function show_backups_ui() {
7252
		/**
7253
		 * Whether UI for backups should be displayed.
7254
		 *
7255
		 * @since 6.5.0
7256
		 *
7257
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7258
		 */
7259
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7260
	}
7261
7262
	/*
7263
	 * Deprecated manage functions
7264
	 */
7265
	function prepare_manage_jetpack_notice() {
7266
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7267
	}
7268
	function manage_activate_screen() {
7269
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7270
	}
7271
	function admin_jetpack_manage_notice() {
7272
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7273
	}
7274
	function opt_out_jetpack_manage_url() {
7275
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7276
	}
7277
	function opt_in_jetpack_manage_url() {
7278
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7279
	}
7280
	function opt_in_jetpack_manage_notice() {
7281
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7282
	}
7283
	function can_display_jetpack_manage_notice() {
7284
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7285
	}
7286
7287
	/**
7288
	 * Clean leftoveruser meta.
7289
	 *
7290
	 * Delete Jetpack-related user meta when it is no longer needed.
7291
	 *
7292
	 * @since 7.3.0
7293
	 *
7294
	 * @param int $user_id User ID being updated.
7295
	 */
7296
	public static function user_meta_cleanup( $user_id ) {
7297
		$meta_keys = array(
7298
			// AtD removed from Jetpack 7.3
7299
			'AtD_options',
7300
			'AtD_check_when',
7301
			'AtD_guess_lang',
7302
			'AtD_ignored_phrases',
7303
		);
7304
7305
		foreach ( $meta_keys as $meta_key ) {
7306
			if ( get_user_meta( $user_id, $meta_key ) ) {
7307
				delete_user_meta( $user_id, $meta_key );
7308
			}
7309
		}
7310
	}
7311
7312
	/**
7313
	 * Checks if a Jetpack site is both active and not in development.
7314
	 *
7315
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7316
	 *
7317
	 * @return bool True if Jetpack is active and not in development.
7318
	 */
7319
	public static function is_active_and_not_development_mode() {
7320
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7321
			return false;
7322
		}
7323
		return true;
7324
	}
7325
}
7326