Completed
Push — update/plugins-loaded-priority... ( b525f3...841a40 )
by
unknown
13:54 queued 06:36
created

Jetpack::upload_handler()   F

Complexity

Conditions 24
Paths 383

Size

Total Lines 131

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 24
nc 383
nop 1
dl 0
loc 131
rs 0.8366
c 0
b 0
f 0

How to fix   Long Method    Complexity   

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