Completed
Push — branch-9.0 ( 750883...e7d257 )
by Jeremy
72:51 queued 64:09
created

class.jetpack.php (83 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

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\Connection\Plugin_Storage as Connection_Plugin_Storage;
9
use Automattic\Jetpack\Connection\Rest_Authentication as Connection_Rest_Authentication;
10
use Automattic\Jetpack\Constants;
11
use Automattic\Jetpack\Licensing;
12
use Automattic\Jetpack\Partner;
13
use Automattic\Jetpack\Roles;
14
use Automattic\Jetpack\Status;
15
use Automattic\Jetpack\Sync\Functions;
16
use Automattic\Jetpack\Sync\Health;
17
use Automattic\Jetpack\Sync\Sender;
18
use Automattic\Jetpack\Sync\Users;
19
use Automattic\Jetpack\Terms_Of_Service;
20
use Automattic\Jetpack\Tracking;
21
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
22
use Automattic\Jetpack\Redirect;
23
use Automattic\Jetpack\Device_Detection\User_Agent_Info;
24
25
/*
26
Options:
27
jetpack_options (array)
28
	An array of options.
29
	@see Jetpack_Options::get_option_names()
30
31
jetpack_register (string)
32
	Temporary verification secrets.
33
34
jetpack_activated (int)
35
	1: the plugin was activated normally
36
	2: the plugin was activated on this site because of a network-wide activation
37
	3: the plugin was auto-installed
38
	4: the plugin was manually disconnected (but is still installed)
39
40
jetpack_active_modules (array)
41
	Array of active module slugs.
42
43
jetpack_do_activate (bool)
44
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
45
*/
46
47
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
48
49
class Jetpack {
50
	public $xmlrpc_server = null;
51
52
	/**
53
	 * @var array The handles of styles that are concatenated into jetpack.css.
54
	 *
55
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
56
	 */
57
	public $concatenated_style_handles = array(
58
		'jetpack-carousel',
59
		'grunion.css',
60
		'the-neverending-homepage',
61
		'jetpack_likes',
62
		'jetpack_related-posts',
63
		'sharedaddy',
64
		'jetpack-slideshow',
65
		'presentations',
66
		'quiz',
67
		'jetpack-subscriptions',
68
		'jetpack-responsive-videos-style',
69
		'jetpack-social-menu',
70
		'tiled-gallery',
71
		'jetpack_display_posts_widget',
72
		'gravatar-profile-widget',
73
		'goodreads-widget',
74
		'jetpack_social_media_icons_widget',
75
		'jetpack-top-posts-widget',
76
		'jetpack_image_widget',
77
		'jetpack-my-community-widget',
78
		'jetpack-authors-widget',
79
		'wordads',
80
		'eu-cookie-law-style',
81
		'flickr-widget-style',
82
		'jetpack-search-widget',
83
		'jetpack-simple-payments-widget-style',
84
		'jetpack-widget-social-icons-styles',
85
		'wpcom_instagram_widget',
86
	);
87
88
	/**
89
	 * Contains all assets that have had their URL rewritten to minified versions.
90
	 *
91
	 * @var array
92
	 */
93
	static $min_assets = array();
94
95
	public $plugins_to_deactivate = array(
96
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
97
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
98
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
99
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
100
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
101
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
102
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
103
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
104
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
105
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
106
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
107
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
108
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
109
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
110
	);
111
112
	/**
113
	 * Map of roles we care about, and their corresponding minimum capabilities.
114
	 *
115
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
116
	 *
117
	 * @access public
118
	 * @static
119
	 *
120
	 * @var array
121
	 */
122
	public static $capability_translations = array(
123
		'administrator' => 'manage_options',
124
		'editor'        => 'edit_others_posts',
125
		'author'        => 'publish_posts',
126
		'contributor'   => 'edit_posts',
127
		'subscriber'    => 'read',
128
	);
129
130
	/**
131
	 * Map of modules that have conflicts with plugins and should not be auto-activated
132
	 * if the plugins are active.  Used by filter_default_modules
133
	 *
134
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
135
	 * change `module-slug` and add this to your plugin:
136
	 *
137
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
138
	 * function my_jetpack_get_default_modules( $modules ) {
139
	 *     return array_diff( $modules, array( 'module-slug' ) );
140
	 * }
141
	 *
142
	 * @var array
143
	 */
144
	private $conflicting_plugins = array(
145
		'comments'           => array(
146
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
147
			'Disqus'                         => 'disqus-comment-system/disqus.php',
148
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
149
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
150
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
151
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
152
		),
153
		'comment-likes'      => array(
154
			'Epoch' => 'epoch/plugincore.php',
155
		),
156
		'contact-form'       => array(
157
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
158
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
159
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
160
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
161
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
162
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
163
		),
164
		'latex'              => array(
165
			'LaTeX for WordPress'     => 'latex/latex.php',
166
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
167
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
168
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
169
			'Enable Latex'            => 'enable-latex/enable-latex.php',
170
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
171
		),
172
		'protect'            => array(
173
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
174
			'Captcha'                           => 'captcha/captcha.php',
175
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
176
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
177
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
178
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
179
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
180
			'Security-protection'               => 'security-protection/security-protection.php',
181
			'Login Security'                    => 'login-security/login-security.php',
182
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
183
			'Wordfence Security'                => 'wordfence/wordfence.php',
184
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
185
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
186
		),
187
		'random-redirect'    => array(
188
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
189
		),
190
		'related-posts'      => array(
191
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
192
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
193
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
194
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
195
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
196
			'outbrain'                    => 'outbrain/outbrain.php',
197
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
198
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
199
		),
200
		'sharedaddy'         => array(
201
			'AddThis'     => 'addthis/addthis_social_widget.php',
202
			'Add To Any'  => 'add-to-any/add-to-any.php',
203
			'ShareThis'   => 'share-this/sharethis.php',
204
			'Shareaholic' => 'shareaholic/shareaholic.php',
205
		),
206
		'seo-tools'          => array(
207
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
208
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
209
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
210
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
211
			'The SEO Framework'              => 'autodescription/autodescription.php',
212
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
213
			'Slim SEO'                       => 'slim-seo/slim-seo.php',
214
		),
215
		'verification-tools' => array(
216
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
217
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
218
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
219
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
220
			'The SEO Framework'              => 'autodescription/autodescription.php',
221
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
222
			'Slim SEO'                       => 'slim-seo/slim-seo.php',
223
		),
224
		'widget-visibility'  => array(
225
			'Widget Logic'    => 'widget-logic/widget_logic.php',
226
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
227
		),
228
		'sitemaps'           => array(
229
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
230
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
231
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
232
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
233
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
234
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
235
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
236
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
237
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
238
			'The SEO Framework'                    => 'autodescription/autodescription.php',
239
			'Sitemap'                              => 'sitemap/sitemap.php',
240
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
241
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
242
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
243
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
244
			'Rank Math'                            => 'seo-by-rank-math/rank-math.php',
245
			'Slim SEO'                             => 'slim-seo/slim-seo.php',
246
		),
247
		'lazy-images'        => array(
248
			'Lazy Load'              => 'lazy-load/lazy-load.php',
249
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
250
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
251
		),
252
	);
253
254
	/**
255
	 * Plugins for which we turn off our Facebook OG Tags implementation.
256
	 *
257
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
258
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
259
	 *
260
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
261
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
262
	 */
263
	private $open_graph_conflicting_plugins = array(
264
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
265
		// 2 Click Social Media Buttons
266
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
267
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
268
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
269
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
270
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
271
		// Open Graph Meta Tags by Heateor
272
		'facebook/facebook.php',                                 // Facebook (official plugin)
273
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
274
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
275
		// Facebook Featured Image & OG Meta Tags
276
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
277
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
278
		// Facebook Open Graph Meta Tags for WordPress
279
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
280
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
281
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
282
		// Fedmich's Facebook Open Graph Meta
283
		'network-publisher/networkpub.php',                      // Network Publisher
284
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
285
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
286
		// NextScripts SNAP
287
		'og-tags/og-tags.php',                                   // OG Tags
288
		'opengraph/opengraph.php',                               // Open Graph
289
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
290
		// Open Graph Protocol Framework
291
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
292
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
293
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
294
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
295
		'sharepress/sharepress.php',                             // SharePress
296
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
297
		'social-discussions/social-discussions.php',             // Social Discussions
298
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
299
		'socialize/socialize.php',                               // Socialize
300
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
301
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
302
		// Tweet, Like, Google +1 and Share
303
		'wordbooker/wordbooker.php',                             // Wordbooker
304
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
305
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
306
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
307
		// WP Facebook Like Send & Open Graph Meta
308
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
309
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
310
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
311
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
312
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
313
		'seo-by-rank-math/rank-math.php',                        // Rank Math.
314
		'slim-seo/slim-seo.php',                                 // Slim SEO
315
	);
316
317
	/**
318
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
319
	 */
320
	private $twitter_cards_conflicting_plugins = array(
321
		// 'twitter/twitter.php',                       // The official one handles this on its own.
322
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
323
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
324
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
325
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
326
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
327
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
328
		'twitter-cards/twitter-cards.php',           // Twitter Cards
329
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
330
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
331
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
332
		'seo-by-rank-math/rank-math.php',            // Rank Math.
333
		'slim-seo/slim-seo.php',                     // Slim SEO
334
	);
335
336
	/**
337
	 * Message to display in admin_notice
338
	 *
339
	 * @var string
340
	 */
341
	public $message = '';
342
343
	/**
344
	 * Error to display in admin_notice
345
	 *
346
	 * @var string
347
	 */
348
	public $error = '';
349
350
	/**
351
	 * Modules that need more privacy description.
352
	 *
353
	 * @var string
354
	 */
355
	public $privacy_checks = '';
356
357
	/**
358
	 * Stats to record once the page loads
359
	 *
360
	 * @var array
361
	 */
362
	public $stats = array();
363
364
	/**
365
	 * Jetpack_Sync object
366
	 */
367
	public $sync;
368
369
	/**
370
	 * Verified data for JSON authorization request
371
	 */
372
	public $json_api_authorization_request = array();
373
374
	/**
375
	 * @var Automattic\Jetpack\Connection\Manager
376
	 */
377
	protected $connection_manager;
378
379
	/**
380
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
381
	 */
382
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
383
384
	/**
385
	 * Holds an instance of Automattic\Jetpack\A8c_Mc_Stats
386
	 *
387
	 * @var Automattic\Jetpack\A8c_Mc_Stats
388
	 */
389
	public $a8c_mc_stats_instance;
390
391
	/**
392
	 * Constant for login redirect key.
393
	 *
394
	 * @var string
395
	 * @since 8.4.0
396
	 */
397
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
398
399
	/**
400
	 * Holds the singleton instance of this class
401
	 *
402
	 * @since 2.3.3
403
	 * @var Jetpack
404
	 */
405
	static $instance = false;
406
407
	/**
408
	 * Singleton
409
	 *
410
	 * @static
411
	 */
412
	public static function init() {
413
		if ( ! self::$instance ) {
414
			self::$instance = new Jetpack();
415
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
416
		}
417
418
		return self::$instance;
419
	}
420
421
	/**
422
	 * Must never be called statically
423
	 */
424
	function plugin_upgrade() {
425
		if ( self::is_active() ) {
426
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
427
			if ( JETPACK__VERSION != $version ) {
428
				// Prevent multiple upgrades at once - only a single process should trigger
429
				// an upgrade to avoid stampedes
430
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
431
					return;
432
				}
433
434
				// Set a short lock to prevent multiple instances of the upgrade
435
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
436
437
				// check which active modules actually exist and remove others from active_modules list
438
				$unfiltered_modules = self::get_active_modules();
439
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
440
				if ( array_diff( $unfiltered_modules, $modules ) ) {
441
					self::update_active_modules( $modules );
442
				}
443
444
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
445
446
				// Upgrade to 4.3.0
447
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
448
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
449
				}
450
451
				// Make sure Markdown for posts gets turned back on
452
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
453
					update_option( 'wpcom_publish_posts_with_markdown', true );
454
				}
455
456
				/*
457
				 * Minileven deprecation. 8.3.0.
458
				 * Only delete options if not using
459
				 * the replacement standalone Minileven plugin.
460
				 */
461
				if (
462
					! self::is_plugin_active( 'minileven-master/minileven.php' )
463
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
464
				) {
465
					if ( get_option( 'wp_mobile_custom_css' ) ) {
466
						delete_option( 'wp_mobile_custom_css' );
467
					}
468
					if ( get_option( 'wp_mobile_excerpt' ) ) {
469
						delete_option( 'wp_mobile_excerpt' );
470
					}
471
					if ( get_option( 'wp_mobile_featured_images' ) ) {
472
						delete_option( 'wp_mobile_featured_images' );
473
					}
474
					if ( get_option( 'wp_mobile_app_promos' ) ) {
475
						delete_option( 'wp_mobile_app_promos' );
476
					}
477
				}
478
479
				// Upgrade to 8.4.0.
480
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
481
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
482
				}
483
484
				// Update to 8.8.x (WordPress 5.5 Compatibility).
485
				if ( Jetpack_Options::get_option( 'autoupdate_plugins' ) ) {
486
					$updated = update_site_option(
487
						'auto_update_plugins',
488
						array_unique(
489
							array_merge(
490
								(array) Jetpack_Options::get_option( 'autoupdate_plugins', array() ),
491
								(array) get_site_option( 'auto_update_plugins', array() )
492
							)
493
						)
494
					);
495
496
					if ( $updated ) {
497
						Jetpack_Options::delete_option( 'autoupdate_plugins' );
498
					} // Should we have some type of fallback if something fails here?
499
				}
500
501
				if ( did_action( 'wp_loaded' ) ) {
502
					self::upgrade_on_load();
503
				} else {
504
					add_action(
505
						'wp_loaded',
506
						array( __CLASS__, 'upgrade_on_load' )
507
					);
508
				}
509
			}
510
		}
511
	}
512
513
	/**
514
	 * Runs upgrade routines that need to have modules loaded.
515
	 */
516
	static function upgrade_on_load() {
517
518
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
519
		// This can happen in case Jetpack has been just upgraded and is
520
		// being initialized late during the page load. In this case we wait
521
		// until the next proper admin page load with Jetpack active.
522
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
523
			delete_transient( self::$plugin_upgrade_lock_key );
524
525
			return;
526
		}
527
528
		self::maybe_set_version_option();
529
530
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
531
			Jetpack_Widget_Conditions::migrate_post_type_rules();
532
		}
533
534
		if (
535
			class_exists( 'Jetpack_Sitemap_Manager' )
536
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
537
		) {
538
			do_action( 'jetpack_sitemaps_purge_data' );
539
		}
540
541
		// Delete old stats cache
542
		delete_option( 'jetpack_restapi_stats_cache' );
543
544
		delete_transient( self::$plugin_upgrade_lock_key );
545
	}
546
547
	/**
548
	 * Saves all the currently active modules to options.
549
	 * Also fires Action hooks for each newly activated and deactivated module.
550
	 *
551
	 * @param $modules Array Array of active modules to be saved in options.
552
	 *
553
	 * @return $success bool true for success, false for failure.
0 ignored issues
show
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...
554
	 */
555
	static function update_active_modules( $modules ) {
556
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
557
		$active_modules       = self::get_active_modules();
558
		$new_active_modules   = array_diff( $modules, $current_modules );
559
		$new_inactive_modules = array_diff( $active_modules, $modules );
560
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
561
		$reindexed_modules    = array_values( $new_current_modules );
562
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
563
564
		foreach ( $new_active_modules as $module ) {
565
			/**
566
			 * Fires when a specific module is activated.
567
			 *
568
			 * @since 1.9.0
569
			 *
570
			 * @param string $module Module slug.
571
			 * @param boolean $success whether the module was activated. @since 4.2
572
			 */
573
			do_action( 'jetpack_activate_module', $module, $success );
574
			/**
575
			 * Fires when a module is activated.
576
			 * The dynamic part of the filter, $module, is the module slug.
577
			 *
578
			 * @since 1.9.0
579
			 *
580
			 * @param string $module Module slug.
581
			 */
582
			do_action( "jetpack_activate_module_$module", $module );
583
		}
584
585
		foreach ( $new_inactive_modules as $module ) {
586
			/**
587
			 * Fired after a module has been deactivated.
588
			 *
589
			 * @since 4.2.0
590
			 *
591
			 * @param string $module Module slug.
592
			 * @param boolean $success whether the module was deactivated.
593
			 */
594
			do_action( 'jetpack_deactivate_module', $module, $success );
595
			/**
596
			 * Fires when a module is deactivated.
597
			 * The dynamic part of the filter, $module, is the module slug.
598
			 *
599
			 * @since 1.9.0
600
			 *
601
			 * @param string $module Module slug.
602
			 */
603
			do_action( "jetpack_deactivate_module_$module", $module );
604
		}
605
606
		return $success;
607
	}
608
609
	static function delete_active_modules() {
610
		self::update_active_modules( array() );
611
	}
612
613
	/**
614
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
615
	 * available.
616
	 */
617
	public function add_configure_hook() {
618
		global $wp_filter;
619
620
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
621
		if ( false !== $current_priority ) {
622
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
623
		}
624
625
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
626
		sort( $taken_priorities );
627
628
		$first_priority = array_shift( $taken_priorities );
629
630
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
631
			$new_priority = - PHP_INT_MAX;
632
		} else {
633
			$new_priority = $first_priority - 1;
634
		}
635
636
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
637
	}
638
639
	/**
640
	 * Constructor.  Initializes WordPress hooks
641
	 */
642
	private function __construct() {
643
		/*
644
		 * Check for and alert any deprecated hooks
645
		 */
646
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
647
648
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
649
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
650
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
651
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
652
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
653
654
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
655
656
		add_filter(
657
			'jetpack_signature_check_token',
658
			array( __CLASS__, 'verify_onboarding_token' ),
659
			10,
660
			3
661
		);
662
663
		/**
664
		 * Prepare Gutenberg Editor functionality
665
		 */
666
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
667
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
668
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
669
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_extended_blocks' ), 9 );
670
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
671
672
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
673
674
		// Unlink user before deleting the user from WP.com.
675
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
676
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
677
678
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
679
680
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
681
		add_action( 'login_init', array( $this, 'login_init' ) );
682
683
		// Set up the REST authentication hooks.
684
		Connection_Rest_Authentication::init();
685
686
		add_action( 'admin_init', array( $this, 'admin_init' ) );
687
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
688
689
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
690
691
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
692
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
693
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
694
695
		// returns HTTPS support status
696
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
697
698
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
699
700
		add_action( 'wp_ajax_jetpack_wizard_banner', array( 'Jetpack_Wizard_Banner', 'ajax_callback' ) );
701
702
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
703
704
		/**
705
		 * These actions run checks to load additional files.
706
		 * They check for external files or plugins, so they need to run as late as possible.
707
		 */
708
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
709
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
710
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
711
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
712
713
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
714
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
715
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
716
717
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
718
719
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
720
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
721
722
		// A filter to control all just in time messages
723
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
724
725
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
726
727
		/*
728
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
729
		 * We should make sure to only do this for front end links.
730
		 */
731
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
732
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
733
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
734
735
			/*
736
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
737
			 * so they point moderation links on emails to Calypso.
738
			 */
739
			jetpack_require_lib( 'functions.wp-notify' );
740
		}
741
742
		add_action(
743
			'plugins_loaded',
744
			function() {
745
				if ( User_Agent_Info::is_mobile_app() ) {
746
					add_filter( 'get_edit_post_link', '__return_empty_string' );
747
				}
748
			}
749
		);
750
751
		// Update the site's Jetpack plan and products from API on heartbeats.
752
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
753
754
		/**
755
		 * This is the hack to concatenate all css files into one.
756
		 * For description and reasoning see the implode_frontend_css method.
757
		 *
758
		 * Super late priority so we catch all the registered styles.
759
		 */
760
		if ( ! is_admin() ) {
761
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
762
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
763
		}
764
765
		/**
766
		 * These are sync actions that we need to keep track of for jitms
767
		 */
768
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
769
770
		// Actually push the stats on shutdown.
771
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
772
			add_action( 'shutdown', array( $this, 'push_stats' ) );
773
		}
774
775
		// Actions for Manager::authorize().
776
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
777
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
778
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
779
780
		// Filters for the Manager::get_token() urls and request body.
781
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
782
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
783
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
784
785
		// Actions for successful reconnect.
786
		add_action( 'jetpack_reconnection_completed', array( $this, 'reconnection_completed' ) );
787
788
		// Actions for licensing.
789
		Licensing::instance()->initialize();
790
	}
791
792
	/**
793
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
794
	 * Config object.
795
	 */
796
	public function configure() {
797
		$config = new Config();
798
799
		foreach (
800
			array(
801
				'sync',
802
			)
803
			as $feature
804
		) {
805
			$config->ensure( $feature );
806
		}
807
808
		$config->ensure(
809
			'connection',
810
			array(
811
				'slug' => 'jetpack',
812
				'name' => 'Jetpack',
813
			)
814
		);
815
816
		if ( is_admin() ) {
817
			$config->ensure( 'jitm' );
818
		}
819
820
		if ( ! $this->connection_manager ) {
821
			$this->connection_manager = new Connection_Manager( 'jetpack' );
822
		}
823
824
		/*
825
		 * Load things that should only be in Network Admin.
826
		 *
827
		 * For now blow away everything else until a more full
828
		 * understanding of what is needed at the network level is
829
		 * available
830
		 */
831
		if ( is_multisite() ) {
832
			$network = Jetpack_Network::init();
833
			$network->set_connection( $this->connection_manager );
834
		}
835
836
		if ( $this->connection_manager->is_active() ) {
837
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
838
839
			Jetpack_Heartbeat::init();
840
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
841
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
842
				Jetpack_Search_Performance_Logger::init();
843
			}
844
		}
845
846
		// Initialize remote file upload request handlers.
847
		$this->add_remote_request_handlers();
848
849
		/*
850
		 * Enable enhanced handling of previewing sites in Calypso
851
		 */
852
		if ( self::is_active() ) {
853
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
854
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
855
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
856
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
857
		}
858
859
		if ( ( new Tracking( $this->connection_manager ) )->should_enable_tracking( new Terms_Of_Service(), new Status() ) ) {
0 ignored issues
show
$this->connection_manager is of type object<Automattic\Jetpack\Connection\Manager>, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
new \Automattic\Jetpack\Terms_Of_Service() is of type object<Automattic\Jetpack\Terms_Of_Service>, but the function expects a object<Automattic\Jetpac...tpack\Terms_Of_Service>.

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...
new \Automattic\Jetpack\Status() is of type object<Automattic\Jetpack\Status>, but the function expects a object<Automattic\Jetpac...omattic\Jetpack\Status>.

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...
860
			add_action( 'init', array( new Plugin_Tracking(), 'init' ) );
861
		} else {
862
			/**
863
			 * Initialize tracking right after the user agrees to the terms of service.
864
			 */
865
			add_action( 'jetpack_agreed_to_terms_of_service', array( new Plugin_Tracking(), 'init' ) );
866
		}
867
	}
868
869
	/**
870
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
871
	 * initialization code.
872
	 *
873
	 * @action plugins_loaded
874
	 */
875
	public function late_initialization() {
876
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
877
878
		Partner::init();
879
880
		/**
881
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
882
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
883
		 *
884
		 * @since 8.1.0
885
		 *
886
		 * @param Jetpack $jetpack the main plugin class object.
887
		 */
888
		do_action( 'jetpack_loaded', $this );
889
890
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
891
	}
892
893
	/**
894
	 * Sets up the XMLRPC request handlers.
895
	 *
896
	 * @deprecated since 7.7.0
897
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
898
	 *
899
	 * @param array                 $request_params Incoming request parameters.
900
	 * @param Boolean               $is_active      Whether the connection is currently active.
901
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
902
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
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...
903
	 */
904 View Code Duplication
	public function setup_xmlrpc_handlers(
905
		$request_params,
906
		$is_active,
907
		$is_signed,
908
		Jetpack_XMLRPC_Server $xmlrpc_server = null
909
	) {
910
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
911
912
		if ( ! $this->connection_manager ) {
913
			$this->connection_manager = new Connection_Manager();
914
		}
915
916
		return $this->connection_manager->setup_xmlrpc_handlers(
917
			$request_params,
918
			$is_active,
919
			$is_signed,
920
			$xmlrpc_server
921
		);
922
	}
923
924
	/**
925
	 * Initialize REST API registration connector.
926
	 *
927
	 * @deprecated since 7.7.0
928
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
929
	 */
930 View Code Duplication
	public function initialize_rest_api_registration_connector() {
931
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
932
933
		if ( ! $this->connection_manager ) {
934
			$this->connection_manager = new Connection_Manager();
935
		}
936
937
		$this->connection_manager->initialize_rest_api_registration_connector();
938
	}
939
940
	/**
941
	 * This is ported over from the manage module, which has been deprecated and baked in here.
942
	 *
943
	 * @param $domains
944
	 */
945
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
946
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
947
	}
948
949
	/**
950
	 * Return $domains, with 'wordpress.com' appended.
951
	 * This is ported over from the manage module, which has been deprecated and baked in here.
952
	 *
953
	 * @param $domains
954
	 * @return array
955
	 */
956
	function allow_wpcom_domain( $domains ) {
957
		if ( empty( $domains ) ) {
958
			$domains = array();
959
		}
960
		$domains[] = 'wordpress.com';
961
		return array_unique( $domains );
962
	}
963
964
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
965
		$post = get_post( $post_id );
966
967
		if ( empty( $post ) ) {
968
			return $default_url;
969
		}
970
971
		$post_type = $post->post_type;
972
973
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
974
		// https://en.support.wordpress.com/custom-post-types/
975
		$allowed_post_types = array(
976
			'post',
977
			'page',
978
			'jetpack-portfolio',
979
			'jetpack-testimonial',
980
		);
981
982
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
983
			return $default_url;
984
		}
985
986
		return Redirect::get_url(
987
			'calypso-edit-' . $post_type,
988
			array(
989
				'path' => $post_id,
990
			)
991
		);
992
	}
993
994
	function point_edit_comment_links_to_calypso( $url ) {
995
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
996
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
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...
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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...
997
998
		return Redirect::get_url(
999
			'calypso-edit-comment',
1000
			array(
1001
				'path' => $query_args['amp;c'],
1002
			)
1003
		);
1004
1005
	}
1006
1007
	function jetpack_track_last_sync_callback( $params ) {
1008
		/**
1009
		 * Filter to turn off jitm caching
1010
		 *
1011
		 * @since 5.4.0
1012
		 *
1013
		 * @param bool false Whether to cache just in time messages
1014
		 */
1015
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
1016
			return $params;
1017
		}
1018
1019
		if ( is_array( $params ) && isset( $params[0] ) ) {
1020
			$option = $params[0];
1021
			if ( 'active_plugins' === $option ) {
1022
				// use the cache if we can, but not terribly important if it gets evicted
1023
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
1024
			}
1025
		}
1026
1027
		return $params;
1028
	}
1029
1030
	function jetpack_connection_banner_callback() {
1031
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
1032
1033
		// Disable the banner dismiss functionality if the pre-connection prompt helpers filter is set.
1034
		if (
1035
			isset( $_REQUEST['dismissBanner'] ) &&
1036
			! Jetpack_Connection_Banner::force_display()
1037
		) {
1038
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
1039
			wp_send_json_success();
1040
		}
1041
1042
		wp_die();
1043
	}
1044
1045
	/**
1046
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1047
	 * Only used in our alternate XML-RPC endpoint, where we want to
1048
	 * ensure that Core and other plugins' methods are not exposed.
1049
	 *
1050
	 * @deprecated since 7.7.0
1051
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1052
	 *
1053
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1054
	 * @return array Filtered $methods
1055
	 */
1056 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1057
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1058
1059
		if ( ! $this->connection_manager ) {
1060
			$this->connection_manager = new Connection_Manager();
1061
		}
1062
1063
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1064
	}
1065
1066
	/**
1067
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1068
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1069
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1070
	 * which is accessible via a different URI. Most of the below is copied directly
1071
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1072
	 *
1073
	 * @deprecated since 7.7.0
1074
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1075
	 */
1076 View Code Duplication
	public function alternate_xmlrpc() {
1077
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1078
1079
		if ( ! $this->connection_manager ) {
1080
			$this->connection_manager = new Connection_Manager();
1081
		}
1082
1083
		$this->connection_manager->alternate_xmlrpc();
1084
	}
1085
1086
	/**
1087
	 * The callback for the JITM ajax requests.
1088
	 *
1089
	 * @deprecated since 7.9.0
1090
	 */
1091
	function jetpack_jitm_ajax_callback() {
1092
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1093
	}
1094
1095
	/**
1096
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1097
	 */
1098
	function push_stats() {
1099
		if ( ! empty( $this->stats ) ) {
1100
			$this->do_stats( 'server_side' );
1101
		}
1102
	}
1103
1104
	/**
1105
	 * Sets the Jetpack custom capabilities.
1106
	 *
1107
	 * @param string[] $caps    Array of the user's capabilities.
1108
	 * @param string   $cap     Capability name.
1109
	 * @param int      $user_id The user ID.
1110
	 * @param array    $args    Adds the context to the cap. Typically the object ID.
1111
	 */
1112
	public function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1113
		$is_offline_mode = ( new Status() )->is_offline_mode();
1114
		switch ( $cap ) {
1115
			case 'jetpack_manage_modules':
1116
			case 'jetpack_activate_modules':
1117
			case 'jetpack_deactivate_modules':
1118
				$caps = array( 'manage_options' );
1119
				break;
1120
			case 'jetpack_configure_modules':
1121
				$caps = array( 'manage_options' );
1122
				break;
1123
			case 'jetpack_manage_autoupdates':
1124
				$caps = array(
1125
					'manage_options',
1126
					'update_plugins',
1127
				);
1128
				break;
1129
			case 'jetpack_network_admin_page':
1130
			case 'jetpack_network_settings_page':
1131
				$caps = array( 'manage_network_plugins' );
1132
				break;
1133
			case 'jetpack_network_sites_page':
1134
				$caps = array( 'manage_sites' );
1135
				break;
1136
			case 'jetpack_admin_page':
1137
				if ( $is_offline_mode ) {
1138
					$caps = array( 'manage_options' );
1139
					break;
1140
				} else {
1141
					$caps = array( 'read' );
1142
				}
1143
				break;
1144
		}
1145
		return $caps;
1146
	}
1147
1148
	/**
1149
	 * Require a Jetpack authentication.
1150
	 *
1151
	 * @deprecated since 7.7.0
1152
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1153
	 */
1154 View Code Duplication
	public function require_jetpack_authentication() {
1155
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1156
1157
		if ( ! $this->connection_manager ) {
1158
			$this->connection_manager = new Connection_Manager();
1159
		}
1160
1161
		$this->connection_manager->require_jetpack_authentication();
1162
	}
1163
1164
	/**
1165
	 * Register assets for use in various modules and the Jetpack admin page.
1166
	 *
1167
	 * @uses wp_script_is, wp_register_script, plugins_url
1168
	 * @action wp_loaded
1169
	 * @return null
1170
	 */
1171
	public function register_assets() {
1172 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1173
			wp_register_script(
1174
				'jetpack-gallery-settings',
1175
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1176
				array( 'media-views' ),
1177
				'20121225'
1178
			);
1179
		}
1180
1181
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1182
			wp_register_script(
1183
				'jetpack-twitter-timeline',
1184
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1185
				array( 'jquery' ),
1186
				'4.0.0',
1187
				true
1188
			);
1189
		}
1190
1191
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1192
			wp_register_script(
1193
				'jetpack-facebook-embed',
1194
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1195
				array(),
1196
				null,
1197
				true
1198
			);
1199
1200
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1201
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1202
			if ( ! is_numeric( $fb_app_id ) ) {
1203
				$fb_app_id = '';
1204
			}
1205
			wp_localize_script(
1206
				'jetpack-facebook-embed',
1207
				'jpfbembed',
1208
				array(
1209
					'appid'  => $fb_app_id,
1210
					'locale' => $this->get_locale(),
1211
				)
1212
			);
1213
		}
1214
1215
		/**
1216
		 * As jetpack_register_genericons is by default fired off a hook,
1217
		 * the hook may have already fired by this point.
1218
		 * So, let's just trigger it manually.
1219
		 */
1220
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1221
		jetpack_register_genericons();
1222
1223
		/**
1224
		 * Register the social logos
1225
		 */
1226
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1227
		jetpack_register_social_logos();
1228
1229 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1230
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1231
		}
1232
	}
1233
1234
	/**
1235
	 * Guess locale from language code.
1236
	 *
1237
	 * @param string $lang Language code.
1238
	 * @return string|bool
1239
	 */
1240 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1241
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1242
			return 'en_US';
1243
		}
1244
1245
		if ( ! class_exists( 'GP_Locales' ) ) {
1246
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1247
				return false;
1248
			}
1249
1250
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1251
		}
1252
1253
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1254
			// WP.com: get_locale() returns 'it'
1255
			$locale = GP_Locales::by_slug( $lang );
1256
		} else {
1257
			// Jetpack: get_locale() returns 'it_IT';
1258
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1259
		}
1260
1261
		if ( ! $locale ) {
1262
			return false;
1263
		}
1264
1265
		if ( empty( $locale->facebook_locale ) ) {
1266
			if ( empty( $locale->wp_locale ) ) {
1267
				return false;
1268
			} else {
1269
				// Facebook SDK is smart enough to fall back to en_US if a
1270
				// locale isn't supported. Since supported Facebook locales
1271
				// can fall out of sync, we'll attempt to use the known
1272
				// wp_locale value and rely on said fallback.
1273
				return $locale->wp_locale;
1274
			}
1275
		}
1276
1277
		return $locale->facebook_locale;
1278
	}
1279
1280
	/**
1281
	 * Get the locale.
1282
	 *
1283
	 * @return string|bool
1284
	 */
1285
	function get_locale() {
1286
		$locale = $this->guess_locale_from_lang( get_locale() );
1287
1288
		if ( ! $locale ) {
1289
			$locale = 'en_US';
1290
		}
1291
1292
		return $locale;
1293
	}
1294
1295
	/**
1296
	 * Return the network_site_url so that .com knows what network this site is a part of.
1297
	 *
1298
	 * @param  bool $option
1299
	 * @return string
1300
	 */
1301
	public function jetpack_main_network_site_option( $option ) {
1302
		return network_site_url();
1303
	}
1304
	/**
1305
	 * Network Name.
1306
	 */
1307
	static function network_name( $option = null ) {
1308
		global $current_site;
1309
		return $current_site->site_name;
1310
	}
1311
	/**
1312
	 * Does the network allow new user and site registrations.
1313
	 *
1314
	 * @return string
1315
	 */
1316
	static function network_allow_new_registrations( $option = null ) {
1317
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1318
	}
1319
	/**
1320
	 * Does the network allow admins to add new users.
1321
	 *
1322
	 * @return boolian
1323
	 */
1324
	static function network_add_new_users( $option = null ) {
1325
		return (bool) get_site_option( 'add_new_users' );
1326
	}
1327
	/**
1328
	 * File upload psace left per site in MB.
1329
	 *  -1 means NO LIMIT.
1330
	 *
1331
	 * @return number
1332
	 */
1333
	static function network_site_upload_space( $option = null ) {
1334
		// value in MB
1335
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1336
	}
1337
1338
	/**
1339
	 * Network allowed file types.
1340
	 *
1341
	 * @return string
1342
	 */
1343
	static function network_upload_file_types( $option = null ) {
1344
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1345
	}
1346
1347
	/**
1348
	 * Maximum file upload size set by the network.
1349
	 *
1350
	 * @return number
1351
	 */
1352
	static function network_max_upload_file_size( $option = null ) {
1353
		// value in KB
1354
		return get_site_option( 'fileupload_maxk', 300 );
1355
	}
1356
1357
	/**
1358
	 * Lets us know if a site allows admins to manage the network.
1359
	 *
1360
	 * @return array
1361
	 */
1362
	static function network_enable_administration_menus( $option = null ) {
1363
		return get_site_option( 'menu_items' );
1364
	}
1365
1366
	/**
1367
	 * If a user has been promoted to or demoted from admin, we need to clear the
1368
	 * jetpack_other_linked_admins transient.
1369
	 *
1370
	 * @since 4.3.2
1371
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1372
	 *
1373
	 * @param int    $user_id   The user ID whose role changed.
1374
	 * @param string $role      The new role.
1375
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
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...
1376
	 */
1377
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1378
		if ( 'administrator' == $role
1379
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1380
			|| is_null( $old_roles )
1381
		) {
1382
			delete_transient( 'jetpack_other_linked_admins' );
1383
		}
1384
	}
1385
1386
	/**
1387
	 * Checks to see if there are any other users available to become primary
1388
	 * Users must both:
1389
	 * - Be linked to wpcom
1390
	 * - Be an admin
1391
	 *
1392
	 * @return mixed False if no other users are linked, Int if there are.
1393
	 */
1394
	static function get_other_linked_admins() {
1395
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1396
1397
		if ( false === $other_linked_users ) {
1398
			$admins = get_users( array( 'role' => 'administrator' ) );
1399
			if ( count( $admins ) > 1 ) {
1400
				$available = array();
1401
				foreach ( $admins as $admin ) {
1402
					if ( self::is_user_connected( $admin->ID ) ) {
1403
						$available[] = $admin->ID;
1404
					}
1405
				}
1406
1407
				$count_connected_admins = count( $available );
1408
				if ( count( $available ) > 1 ) {
1409
					$other_linked_users = $count_connected_admins;
1410
				} else {
1411
					$other_linked_users = 0;
1412
				}
1413
			} else {
1414
				$other_linked_users = 0;
1415
			}
1416
1417
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1418
		}
1419
1420
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1421
	}
1422
1423
	/**
1424
	 * Return whether we are dealing with a multi network setup or not.
1425
	 * The reason we are type casting this is because we want to avoid the situation where
1426
	 * the result is false since when is_main_network_option return false it cases
1427
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1428
	 * database which could be set to anything as opposed to what this function returns.
1429
	 *
1430
	 * @param  bool $option
1431
	 *
1432
	 * @return boolean
1433
	 */
1434
	public function is_main_network_option( $option ) {
1435
		// return '1' or ''
1436
		return (string) (bool) self::is_multi_network();
1437
	}
1438
1439
	/**
1440
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1441
	 *
1442
	 * @param  string $option
1443
	 * @return boolean
1444
	 */
1445
	public function is_multisite( $option ) {
1446
		return (string) (bool) is_multisite();
1447
	}
1448
1449
	/**
1450
	 * Implemented since there is no core is multi network function
1451
	 * Right now there is no way to tell if we which network is the dominant network on the system
1452
	 *
1453
	 * @since  3.3
1454
	 * @return boolean
1455
	 */
1456 View Code Duplication
	public static function is_multi_network() {
1457
		global  $wpdb;
1458
1459
		// if we don't have a multi site setup no need to do any more
1460
		if ( ! is_multisite() ) {
1461
			return false;
1462
		}
1463
1464
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1465
		if ( $num_sites > 1 ) {
1466
			return true;
1467
		} else {
1468
			return false;
1469
		}
1470
	}
1471
1472
	/**
1473
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1474
	 *
1475
	 * @return null
1476
	 */
1477
	function update_jetpack_main_network_site_option() {
1478
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1479
	}
1480
	/**
1481
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1482
	 */
1483
	function update_jetpack_network_settings() {
1484
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1485
		// Only sync this info for the main network site.
1486
	}
1487
1488
	/**
1489
	 * Get back if the current site is single user site.
1490
	 *
1491
	 * @return bool
1492
	 */
1493 View Code Duplication
	public static function is_single_user_site() {
1494
		global $wpdb;
1495
1496
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1497
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1498
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1499
		}
1500
		return 1 === (int) $some_users;
1501
	}
1502
1503
	/**
1504
	 * Returns true if the site has file write access false otherwise.
1505
	 *
1506
	 * @return string ( '1' | '0' )
1507
	 **/
1508
	public static function file_system_write_access() {
1509
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1510
			require_once ABSPATH . 'wp-admin/includes/file.php';
1511
		}
1512
1513
		require_once ABSPATH . 'wp-admin/includes/template.php';
1514
1515
		$filesystem_method = get_filesystem_method();
1516
		if ( $filesystem_method === 'direct' ) {
1517
			return 1;
1518
		}
1519
1520
		ob_start();
1521
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1522
		ob_end_clean();
1523
		if ( $filesystem_credentials_are_stored ) {
1524
			return 1;
1525
		}
1526
		return 0;
1527
	}
1528
1529
	/**
1530
	 * Finds out if a site is using a version control system.
1531
	 *
1532
	 * @return string ( '1' | '0' )
1533
	 **/
1534
	public static function is_version_controlled() {
1535
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1536
		return (string) (int) Functions::is_version_controlled();
1537
	}
1538
1539
	/**
1540
	 * Determines whether the current theme supports featured images or not.
1541
	 *
1542
	 * @return string ( '1' | '0' )
1543
	 */
1544
	public static function featured_images_enabled() {
1545
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1546
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1547
	}
1548
1549
	/**
1550
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1551
	 *
1552
	 * @deprecated 4.7 use get_avatar_url instead.
1553
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1554
	 * @param int               $size Size of the avatar image
1555
	 * @param string            $default URL to a default image to use if no avatar is available
1556
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1557
	 *
1558
	 * @return array
1559
	 */
1560
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1561
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1562
		return get_avatar_url(
1563
			$id_or_email,
1564
			array(
1565
				'size'          => $size,
1566
				'default'       => $default,
1567
				'force_default' => $force_display,
1568
			)
1569
		);
1570
	}
1571
1572
	/**
1573
	 * jetpack_updates is saved in the following schema:
1574
	 *
1575
	 * array (
1576
	 *      'plugins'                       => (int) Number of plugin updates available.
1577
	 *      'themes'                        => (int) Number of theme updates available.
1578
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1579
	 *      'translations'                  => (int) Number of translation updates available.
1580
	 *      'total'                         => (int) Total of all available updates.
1581
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1582
	 * )
1583
	 *
1584
	 * @return array
1585
	 */
1586
	public static function get_updates() {
1587
		$update_data = wp_get_update_data();
1588
1589
		// Stores the individual update counts as well as the total count.
1590
		if ( isset( $update_data['counts'] ) ) {
1591
			$updates = $update_data['counts'];
1592
		}
1593
1594
		// If we need to update WordPress core, let's find the latest version number.
1595 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1596
			$cur = get_preferred_from_update_core();
1597
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1598
				$updates['wp_update_version'] = $cur->current;
1599
			}
1600
		}
1601
		return isset( $updates ) ? $updates : array();
1602
	}
1603
1604
	public static function get_update_details() {
1605
		$update_details = array(
1606
			'update_core'    => get_site_transient( 'update_core' ),
1607
			'update_plugins' => get_site_transient( 'update_plugins' ),
1608
			'update_themes'  => get_site_transient( 'update_themes' ),
1609
		);
1610
		return $update_details;
1611
	}
1612
1613
	public static function refresh_update_data() {
1614
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1615
1616
	}
1617
1618
	public static function refresh_theme_data() {
1619
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1620
	}
1621
1622
	/**
1623
	 * Is Jetpack active?
1624
	 * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1625
	 *
1626
	 * @return bool
1627
	 */
1628
	public static function is_active() {
1629
		return self::connection()->is_active();
1630
	}
1631
1632
	/**
1633
	 * Make an API call to WordPress.com for plan status
1634
	 *
1635
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1636
	 *
1637
	 * @return bool True if plan is updated, false if no update
1638
	 */
1639
	public static function refresh_active_plan_from_wpcom() {
1640
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1641
		return Jetpack_Plan::refresh_from_wpcom();
1642
	}
1643
1644
	/**
1645
	 * Get the plan that this Jetpack site is currently using
1646
	 *
1647
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1648
	 * @return array Active Jetpack plan details.
1649
	 */
1650
	public static function get_active_plan() {
1651
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1652
		return Jetpack_Plan::get();
1653
	}
1654
1655
	/**
1656
	 * Determine whether the active plan supports a particular feature
1657
	 *
1658
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1659
	 * @return bool True if plan supports feature, false if not.
1660
	 */
1661
	public static function active_plan_supports( $feature ) {
1662
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1663
		return Jetpack_Plan::supports( $feature );
1664
	}
1665
1666
	/**
1667
	 * Deprecated: Is Jetpack in development (offline) mode?
1668
	 *
1669
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1670
	 * and themes still use it, and we do not want to flood them with notices.
1671
	 *
1672
	 * Please use Automattic\Jetpack\Status()->is_offline_mode() instead.
1673
	 *
1674
	 * @deprecated since 8.0.
1675
	 */
1676
	public static function is_development_mode() {
1677
		return ( new Status() )->is_offline_mode();
1678
	}
1679
1680
	/**
1681
	 * Whether the site is currently onboarding or not.
1682
	 * A site is considered as being onboarded if it currently has an onboarding token.
1683
	 *
1684
	 * @since 5.8
1685
	 *
1686
	 * @access public
1687
	 * @static
1688
	 *
1689
	 * @return bool True if the site is currently onboarding, false otherwise
1690
	 */
1691
	public static function is_onboarding() {
1692
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1693
	}
1694
1695
	/**
1696
	 * Determines reason for Jetpack offline mode.
1697
	 */
1698
	public static function development_mode_trigger_text() {
1699
		$status = new Status();
1700
1701
		if ( ! $status->is_offline_mode() ) {
1702
			return __( 'Jetpack is not in Offline Mode.', 'jetpack' );
1703
		}
1704
1705
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1706
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1707
		} elseif ( defined( 'WP_LOCAL_DEV' ) && WP_LOCAL_DEV ) {
1708
			$notice = __( 'The WP_LOCAL_DEV constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1709
		} elseif ( $status->is_local_site() ) {
1710
			$notice = __( 'The site URL is a known local development environment URL (e.g. http://localhost).', 'jetpack' );
1711
			/** This filter is documented in packages/status/src/class-status.php */
1712
		} elseif ( has_filter( 'jetpack_development_mode' ) && apply_filters( 'jetpack_development_mode', false ) ) { // This is a deprecated filter name.
1713
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1714
		} else {
1715
			$notice = __( 'The jetpack_offline_mode filter is set to true.', 'jetpack' );
1716
		}
1717
1718
		return $notice;
1719
1720
	}
1721
	/**
1722
	 * Get Jetpack offline mode notice text and notice class.
1723
	 *
1724
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_offline_mode
1725
	 */
1726
	public static function show_development_mode_notice() {
1727 View Code Duplication
		if ( ( new Status() )->is_offline_mode() ) {
1728
			$notice = sprintf(
1729
				/* translators: %s is a URL */
1730
				__( 'In <a href="%s" target="_blank">Offline Mode</a>:', 'jetpack' ),
1731
				Redirect::get_url( 'jetpack-support-development-mode' )
1732
			);
1733
1734
			$notice .= ' ' . self::development_mode_trigger_text();
1735
1736
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1737
		}
1738
1739
		// Throw up a notice if using a development version and as for feedback.
1740
		if ( self::is_development_version() ) {
1741
			/* translators: %s is a URL */
1742
			$notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), Redirect::get_url( 'jetpack-contact-support-beta-group' ) );
1743
1744
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1745
		}
1746
		// Throw up a notice if using staging mode
1747 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1748
			/* translators: %s is a URL */
1749
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1750
1751
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1752
		}
1753
	}
1754
1755
	/**
1756
	 * Whether Jetpack's version maps to a public release, or a development version.
1757
	 */
1758
	public static function is_development_version() {
1759
		/**
1760
		 * Allows filtering whether this is a development version of Jetpack.
1761
		 *
1762
		 * This filter is especially useful for tests.
1763
		 *
1764
		 * @since 4.3.0
1765
		 *
1766
		 * @param bool $development_version Is this a develoment version of Jetpack?
1767
		 */
1768
		return (bool) apply_filters(
1769
			'jetpack_development_version',
1770
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1771
		);
1772
	}
1773
1774
	/**
1775
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1776
	 */
1777
	public static function is_user_connected( $user_id = false ) {
1778
		return self::connection()->is_user_connected( $user_id );
1779
	}
1780
1781
	/**
1782
	 * Get the wpcom user data of the current|specified connected user.
1783
	 */
1784 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1785
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1786
		if ( ! $user_id ) {
1787
			$user_id = get_current_user_id();
1788
		}
1789
1790
		$transient_key = "jetpack_connected_user_data_$user_id";
1791
1792
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1793
			return $cached_user_data;
1794
		}
1795
1796
		$xml = new Jetpack_IXR_Client(
1797
			array(
1798
				'user_id' => $user_id,
1799
			)
1800
		);
1801
		$xml->query( 'wpcom.getUser' );
1802
		if ( ! $xml->isError() ) {
1803
			$user_data = $xml->getResponse();
1804
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1805
			return $user_data;
1806
		}
1807
1808
		return false;
1809
	}
1810
1811
	/**
1812
	 * Get the wpcom email of the current|specified connected user.
1813
	 */
1814
	public static function get_connected_user_email( $user_id = null ) {
1815
		if ( ! $user_id ) {
1816
			$user_id = get_current_user_id();
1817
		}
1818
1819
		$xml = new Jetpack_IXR_Client(
1820
			array(
1821
				'user_id' => $user_id,
1822
			)
1823
		);
1824
		$xml->query( 'wpcom.getUserEmail' );
1825
		if ( ! $xml->isError() ) {
1826
			return $xml->getResponse();
1827
		}
1828
		return false;
1829
	}
1830
1831
	/**
1832
	 * Get the wpcom email of the master user.
1833
	 */
1834
	public static function get_master_user_email() {
1835
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1836
		if ( $master_user_id ) {
1837
			return self::get_connected_user_email( $master_user_id );
1838
		}
1839
		return '';
1840
	}
1841
1842
	/**
1843
	 * Whether the current user is the connection owner.
1844
	 *
1845
	 * @deprecated since 7.7
1846
	 *
1847
	 * @return bool Whether the current user is the connection owner.
1848
	 */
1849
	public function current_user_is_connection_owner() {
1850
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1851
		return self::connection()->is_connection_owner();
1852
	}
1853
1854
	/**
1855
	 * Gets current user IP address.
1856
	 *
1857
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1858
	 *
1859
	 * @return string                  Current user IP address.
1860
	 */
1861
	public static function current_user_ip( $check_all_headers = false ) {
1862
		if ( $check_all_headers ) {
1863
			foreach ( array(
1864
				'HTTP_CF_CONNECTING_IP',
1865
				'HTTP_CLIENT_IP',
1866
				'HTTP_X_FORWARDED_FOR',
1867
				'HTTP_X_FORWARDED',
1868
				'HTTP_X_CLUSTER_CLIENT_IP',
1869
				'HTTP_FORWARDED_FOR',
1870
				'HTTP_FORWARDED',
1871
				'HTTP_VIA',
1872
			) as $key ) {
1873
				if ( ! empty( $_SERVER[ $key ] ) ) {
1874
					return $_SERVER[ $key ];
1875
				}
1876
			}
1877
		}
1878
1879
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1880
	}
1881
1882
	/**
1883
	 * Synchronize connected user role changes
1884
	 */
1885
	function user_role_change( $user_id ) {
1886
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1887
		Users::user_role_change( $user_id );
1888
	}
1889
1890
	/**
1891
	 * Loads the currently active modules.
1892
	 */
1893
	public static function load_modules() {
1894
		$is_offline_mode = ( new Status() )->is_offline_mode();
1895
		if (
1896
			! self::is_active()
1897
			&& ! $is_offline_mode
1898
			&& ! self::is_onboarding()
1899
			&& (
1900
				! is_multisite()
1901
				|| ! get_site_option( 'jetpack_protect_active' )
1902
			)
1903
		) {
1904
			return;
1905
		}
1906
1907
		$version = Jetpack_Options::get_option( 'version' );
1908 View Code Duplication
		if ( ! $version ) {
1909
			$version = $old_version = JETPACK__VERSION . ':' . time();
1910
			/** This action is documented in class.jetpack.php */
1911
			do_action( 'updating_jetpack_version', $version, false );
1912
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1913
		}
1914
		list( $version ) = explode( ':', $version );
1915
1916
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1917
1918
		$modules_data = array();
1919
1920
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1921
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1922
			$updated_modules = array();
1923
			foreach ( $modules as $module ) {
1924
				$modules_data[ $module ] = self::get_module( $module );
1925
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1926
					continue;
1927
				}
1928
1929
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1930
					continue;
1931
				}
1932
1933
				$updated_modules[] = $module;
1934
			}
1935
1936
			$modules = array_diff( $modules, $updated_modules );
1937
		}
1938
1939
		foreach ( $modules as $index => $module ) {
1940
			// If we're in offline mode, disable modules requiring a connection.
1941
			if ( $is_offline_mode ) {
1942
				// Prime the pump if we need to
1943
				if ( empty( $modules_data[ $module ] ) ) {
1944
					$modules_data[ $module ] = self::get_module( $module );
1945
				}
1946
				// If the module requires a connection, but we're in local mode, don't include it.
1947
				if ( $modules_data[ $module ]['requires_connection'] ) {
1948
					continue;
1949
				}
1950
			}
1951
1952
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1953
				continue;
1954
			}
1955
1956
			if ( ! include_once self::get_module_path( $module ) ) {
1957
				unset( $modules[ $index ] );
1958
				self::update_active_modules( array_values( $modules ) );
1959
				continue;
1960
			}
1961
1962
			/**
1963
			 * Fires when a specific module is loaded.
1964
			 * The dynamic part of the hook, $module, is the module slug.
1965
			 *
1966
			 * @since 1.1.0
1967
			 */
1968
			do_action( 'jetpack_module_loaded_' . $module );
1969
		}
1970
1971
		/**
1972
		 * Fires when all the modules are loaded.
1973
		 *
1974
		 * @since 1.1.0
1975
		 */
1976
		do_action( 'jetpack_modules_loaded' );
1977
1978
		// 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.
1979
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1980
	}
1981
1982
	/**
1983
	 * Check if Jetpack's REST API compat file should be included
1984
	 *
1985
	 * @action plugins_loaded
1986
	 * @return null
1987
	 */
1988
	public function check_rest_api_compat() {
1989
		/**
1990
		 * Filters the list of REST API compat files to be included.
1991
		 *
1992
		 * @since 2.2.5
1993
		 *
1994
		 * @param array $args Array of REST API compat files to include.
1995
		 */
1996
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1997
1998
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1999
			require_once $_jetpack_rest_api_compat_include;
2000
		}
2001
	}
2002
2003
	/**
2004
	 * Gets all plugins currently active in values, regardless of whether they're
2005
	 * traditionally activated or network activated.
2006
	 *
2007
	 * @todo Store the result in core's object cache maybe?
2008
	 */
2009
	public static function get_active_plugins() {
2010
		$active_plugins = (array) get_option( 'active_plugins', array() );
2011
2012
		if ( is_multisite() ) {
2013
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2014
			// whereas active_plugins stores them in the values.
2015
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2016
			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...
2017
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2018
			}
2019
		}
2020
2021
		sort( $active_plugins );
2022
2023
		return array_unique( $active_plugins );
2024
	}
2025
2026
	/**
2027
	 * Gets and parses additional plugin data to send with the heartbeat data
2028
	 *
2029
	 * @since 3.8.1
2030
	 *
2031
	 * @return array Array of plugin data
2032
	 */
2033
	public static function get_parsed_plugin_data() {
2034
		if ( ! function_exists( 'get_plugins' ) ) {
2035
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2036
		}
2037
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2038
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2039
		$active_plugins = self::get_active_plugins();
2040
2041
		$plugins = array();
2042
		foreach ( $all_plugins as $path => $plugin_data ) {
2043
			$plugins[ $path ] = array(
2044
				'is_active' => in_array( $path, $active_plugins ),
2045
				'file'      => $path,
2046
				'name'      => $plugin_data['Name'],
2047
				'version'   => $plugin_data['Version'],
2048
				'author'    => $plugin_data['Author'],
2049
			);
2050
		}
2051
2052
		return $plugins;
2053
	}
2054
2055
	/**
2056
	 * Gets and parses theme data to send with the heartbeat data
2057
	 *
2058
	 * @since 3.8.1
2059
	 *
2060
	 * @return array Array of theme data
2061
	 */
2062
	public static function get_parsed_theme_data() {
2063
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2064
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2065
2066
		$themes = array();
2067
		foreach ( $all_themes as $slug => $theme_data ) {
2068
			$theme_headers = array();
2069
			foreach ( $header_keys as $header_key ) {
2070
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2071
			}
2072
2073
			$themes[ $slug ] = array(
2074
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2075
				'slug'            => $slug,
2076
				'theme_root'      => $theme_data->get_theme_root_uri(),
2077
				'parent'          => $theme_data->parent(),
2078
				'headers'         => $theme_headers,
2079
			);
2080
		}
2081
2082
		return $themes;
2083
	}
2084
2085
	/**
2086
	 * Checks whether a specific plugin is active.
2087
	 *
2088
	 * We don't want to store these in a static variable, in case
2089
	 * there are switch_to_blog() calls involved.
2090
	 */
2091
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2092
		return in_array( $plugin, self::get_active_plugins() );
2093
	}
2094
2095
	/**
2096
	 * Check if Jetpack's Open Graph tags should be used.
2097
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2098
	 *
2099
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2100
	 * @action plugins_loaded
2101
	 * @return null
2102
	 */
2103
	public function check_open_graph() {
2104
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2105
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2106
		}
2107
2108
		$active_plugins = self::get_active_plugins();
2109
2110
		if ( ! empty( $active_plugins ) ) {
2111
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2112
				if ( in_array( $plugin, $active_plugins ) ) {
2113
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2114
					break;
2115
				}
2116
			}
2117
		}
2118
2119
		/**
2120
		 * Allow the addition of Open Graph Meta Tags to all pages.
2121
		 *
2122
		 * @since 2.0.3
2123
		 *
2124
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2125
		 */
2126
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2127
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2128
		}
2129
	}
2130
2131
	/**
2132
	 * Check if Jetpack's Twitter tags should be used.
2133
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2134
	 *
2135
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2136
	 * @action plugins_loaded
2137
	 * @return null
2138
	 */
2139
	public function check_twitter_tags() {
2140
2141
		$active_plugins = self::get_active_plugins();
2142
2143
		if ( ! empty( $active_plugins ) ) {
2144
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2145
				if ( in_array( $plugin, $active_plugins ) ) {
2146
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2147
					break;
2148
				}
2149
			}
2150
		}
2151
2152
		/**
2153
		 * Allow Twitter Card Meta tags to be disabled.
2154
		 *
2155
		 * @since 2.6.0
2156
		 *
2157
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2158
		 */
2159
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2160
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2161
		}
2162
	}
2163
2164
	/**
2165
	 * Allows plugins to submit security reports.
2166
	 *
2167
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2168
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2169
	 * @param array  $args         See definitions above
2170
	 */
2171
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2172
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2173
	}
2174
2175
	/* Jetpack Options API */
2176
2177
	public static function get_option_names( $type = 'compact' ) {
2178
		return Jetpack_Options::get_option_names( $type );
2179
	}
2180
2181
	/**
2182
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2183
	 *
2184
	 * @param string $name    Option name
2185
	 * @param mixed  $default (optional)
2186
	 */
2187
	public static function get_option( $name, $default = false ) {
2188
		return Jetpack_Options::get_option( $name, $default );
2189
	}
2190
2191
	/**
2192
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2193
	 *
2194
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2195
	 * @param string $name  Option name
2196
	 * @param mixed  $value Option value
2197
	 */
2198
	public static function update_option( $name, $value ) {
2199
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2200
		return Jetpack_Options::update_option( $name, $value );
2201
	}
2202
2203
	/**
2204
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2205
	 *
2206
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2207
	 * @param array $array array( option name => option value, ... )
2208
	 */
2209
	public static function update_options( $array ) {
2210
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2211
		return Jetpack_Options::update_options( $array );
2212
	}
2213
2214
	/**
2215
	 * Deletes the given option.  May be passed multiple option names as an array.
2216
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2217
	 *
2218
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2219
	 * @param string|array $names
2220
	 */
2221
	public static function delete_option( $names ) {
2222
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2223
		return Jetpack_Options::delete_option( $names );
2224
	}
2225
2226
	/**
2227
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2228
	 *
2229
	 * Enters a user token into the user_tokens option
2230
	 *
2231
	 * @param int    $user_id The user id.
2232
	 * @param string $token The user token.
2233
	 * @param bool   $is_master_user Whether the user is the master user.
2234
	 * @return bool
2235
	 */
2236
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2237
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2238
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2239
	}
2240
2241
	/**
2242
	 * Returns an array of all PHP files in the specified absolute path.
2243
	 * Equivalent to glob( "$absolute_path/*.php" ).
2244
	 *
2245
	 * @param string $absolute_path The absolute path of the directory to search.
2246
	 * @return array Array of absolute paths to the PHP files.
2247
	 */
2248
	public static function glob_php( $absolute_path ) {
2249
		if ( function_exists( 'glob' ) ) {
2250
			return glob( "$absolute_path/*.php" );
2251
		}
2252
2253
		$absolute_path = untrailingslashit( $absolute_path );
2254
		$files         = array();
2255
		if ( ! $dir = @opendir( $absolute_path ) ) {
2256
			return $files;
2257
		}
2258
2259
		while ( false !== $file = readdir( $dir ) ) {
2260
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2261
				continue;
2262
			}
2263
2264
			$file = "$absolute_path/$file";
2265
2266
			if ( ! is_file( $file ) ) {
2267
				continue;
2268
			}
2269
2270
			$files[] = $file;
2271
		}
2272
2273
		closedir( $dir );
2274
2275
		return $files;
2276
	}
2277
2278
	public static function activate_new_modules( $redirect = false ) {
2279
		if ( ! self::is_active() && ! ( new Status() )->is_offline_mode() ) {
2280
			return;
2281
		}
2282
2283
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2284 View Code Duplication
		if ( ! $jetpack_old_version ) {
2285
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2286
			/** This action is documented in class.jetpack.php */
2287
			do_action( 'updating_jetpack_version', $version, false );
2288
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2289
		}
2290
2291
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2292
2293
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2294
			return;
2295
		}
2296
2297
		$active_modules     = self::get_active_modules();
2298
		$reactivate_modules = array();
2299
		foreach ( $active_modules as $active_module ) {
2300
			$module = self::get_module( $active_module );
2301
			if ( ! isset( $module['changed'] ) ) {
2302
				continue;
2303
			}
2304
2305
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2306
				continue;
2307
			}
2308
2309
			$reactivate_modules[] = $active_module;
2310
			self::deactivate_module( $active_module );
2311
		}
2312
2313
		$new_version = JETPACK__VERSION . ':' . time();
2314
		/** This action is documented in class.jetpack.php */
2315
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2316
		Jetpack_Options::update_options(
2317
			array(
2318
				'version'     => $new_version,
2319
				'old_version' => $jetpack_old_version,
2320
			)
2321
		);
2322
2323
		self::state( 'message', 'modules_activated' );
2324
2325
		self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
0 ignored issues
show
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2326
2327
		if ( $redirect ) {
2328
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2329
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2330
				$page = $_GET['page'];
2331
			}
2332
2333
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2334
			exit;
2335
		}
2336
	}
2337
2338
	/**
2339
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2340
	 * Make sure to tuck away module "library" files in a sub-directory.
2341
	 */
2342
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2343
		static $modules = null;
2344
2345
		if ( ! isset( $modules ) ) {
2346
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2347
			// Use the cache if we're on the front-end and it's available...
2348
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2349
				$modules = $available_modules_option[ JETPACK__VERSION ];
2350
			} else {
2351
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2352
2353
				$modules = array();
2354
2355
				foreach ( $files as $file ) {
2356
					if ( ! $headers = self::get_module( $file ) ) {
2357
						continue;
2358
					}
2359
2360
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2361
				}
2362
2363
				Jetpack_Options::update_option(
2364
					'available_modules',
2365
					array(
2366
						JETPACK__VERSION => $modules,
2367
					)
2368
				);
2369
			}
2370
		}
2371
2372
		/**
2373
		 * Filters the array of modules available to be activated.
2374
		 *
2375
		 * @since 2.4.0
2376
		 *
2377
		 * @param array $modules Array of available modules.
2378
		 * @param string $min_version Minimum version number required to use modules.
2379
		 * @param string $max_version Maximum version number required to use modules.
2380
		 */
2381
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $min_version.

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...
2382
2383
		if ( ! $min_version && ! $max_version ) {
2384
			return array_keys( $mods );
2385
		}
2386
2387
		$r = array();
2388
		foreach ( $mods as $slug => $introduced ) {
2389
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2390
				continue;
2391
			}
2392
2393
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2394
				continue;
2395
			}
2396
2397
			$r[] = $slug;
2398
		}
2399
2400
		return $r;
2401
	}
2402
2403
	/**
2404
	 * Default modules loaded on activation.
2405
	 */
2406
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2407
		$return = array();
2408
2409
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2410
			$module_data = self::get_module( $module );
2411
2412
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2413
				case 'yes':
2414
					$return[] = $module;
2415
					break;
2416
				case 'public':
2417
					if ( Jetpack_Options::get_option( 'public' ) ) {
2418
						$return[] = $module;
2419
					}
2420
					break;
2421
				case 'no':
2422
				default:
2423
					break;
2424
			}
2425
		}
2426
		/**
2427
		 * Filters the array of default modules.
2428
		 *
2429
		 * @since 2.5.0
2430
		 *
2431
		 * @param array $return Array of default modules.
2432
		 * @param string $min_version Minimum version number required to use modules.
2433
		 * @param string $max_version Maximum version number required to use modules.
2434
		 */
2435
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $min_version.

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...
2436
	}
2437
2438
	/**
2439
	 * Checks activated modules during auto-activation to determine
2440
	 * if any of those modules are being deprecated.  If so, close
2441
	 * them out, and add any replacement modules.
2442
	 *
2443
	 * Runs at priority 99 by default.
2444
	 *
2445
	 * This is run late, so that it can still activate a module if
2446
	 * the new module is a replacement for another that the user
2447
	 * currently has active, even if something at the normal priority
2448
	 * would kibosh everything.
2449
	 *
2450
	 * @since 2.6
2451
	 * @uses jetpack_get_default_modules filter
2452
	 * @param array $modules
2453
	 * @return array
2454
	 */
2455
	function handle_deprecated_modules( $modules ) {
2456
		$deprecated_modules = array(
2457
			'debug'            => null,  // Closed out and moved to the debugger library.
2458
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2459
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2460
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2461
		);
2462
2463
		// Don't activate SSO if they never completed activating WPCC.
2464
		if ( self::is_module_active( 'wpcc' ) ) {
2465
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2466
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2467
				$deprecated_modules['wpcc'] = null;
2468
			}
2469
		}
2470
2471
		foreach ( $deprecated_modules as $module => $replacement ) {
2472
			if ( self::is_module_active( $module ) ) {
2473
				self::deactivate_module( $module );
2474
				if ( $replacement ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $replacement of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
2475
					$modules[] = $replacement;
2476
				}
2477
			}
2478
		}
2479
2480
		return array_unique( $modules );
2481
	}
2482
2483
	/**
2484
	 * Checks activated plugins during auto-activation to determine
2485
	 * if any of those plugins are in the list with a corresponding module
2486
	 * that is not compatible with the plugin. The module will not be allowed
2487
	 * to auto-activate.
2488
	 *
2489
	 * @since 2.6
2490
	 * @uses jetpack_get_default_modules filter
2491
	 * @param array $modules
2492
	 * @return array
2493
	 */
2494
	function filter_default_modules( $modules ) {
2495
2496
		$active_plugins = self::get_active_plugins();
2497
2498
		if ( ! empty( $active_plugins ) ) {
2499
2500
			// For each module we'd like to auto-activate...
2501
			foreach ( $modules as $key => $module ) {
2502
				// If there are potential conflicts for it...
2503
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2504
					// For each potential conflict...
2505
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2506
						// If that conflicting plugin is active...
2507
						if ( in_array( $plugin, $active_plugins ) ) {
2508
							// Remove that item from being auto-activated.
2509
							unset( $modules[ $key ] );
2510
						}
2511
					}
2512
				}
2513
			}
2514
		}
2515
2516
		return $modules;
2517
	}
2518
2519
	/**
2520
	 * Extract a module's slug from its full path.
2521
	 */
2522
	public static function get_module_slug( $file ) {
2523
		return str_replace( '.php', '', basename( $file ) );
2524
	}
2525
2526
	/**
2527
	 * Generate a module's path from its slug.
2528
	 */
2529
	public static function get_module_path( $slug ) {
2530
		/**
2531
		 * Filters the path of a modules.
2532
		 *
2533
		 * @since 7.4.0
2534
		 *
2535
		 * @param array $return The absolute path to a module's root php file
2536
		 * @param string $slug The module slug
2537
		 */
2538
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $slug.

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...
2539
	}
2540
2541
	/**
2542
	 * Load module data from module file. Headers differ from WordPress
2543
	 * plugin headers to avoid them being identified as standalone
2544
	 * plugins on the WordPress plugins page.
2545
	 */
2546
	public static function get_module( $module ) {
2547
		$headers = array(
2548
			'name'                      => 'Module Name',
2549
			'description'               => 'Module Description',
2550
			'sort'                      => 'Sort Order',
2551
			'recommendation_order'      => 'Recommendation Order',
2552
			'introduced'                => 'First Introduced',
2553
			'changed'                   => 'Major Changes In',
2554
			'deactivate'                => 'Deactivate',
2555
			'free'                      => 'Free',
2556
			'requires_connection'       => 'Requires Connection',
2557
			'auto_activate'             => 'Auto Activate',
2558
			'module_tags'               => 'Module Tags',
2559
			'feature'                   => 'Feature',
2560
			'additional_search_queries' => 'Additional Search Queries',
2561
			'plan_classes'              => 'Plans',
2562
		);
2563
2564
		$file = self::get_module_path( self::get_module_slug( $module ) );
2565
2566
		$mod = self::get_file_data( $file, $headers );
2567
		if ( empty( $mod['name'] ) ) {
2568
			return false;
2569
		}
2570
2571
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2572
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2573
		$mod['deactivate']           = empty( $mod['deactivate'] );
2574
		$mod['free']                 = empty( $mod['free'] );
2575
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2576
2577
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2578
			$mod['auto_activate'] = 'No';
2579
		} else {
2580
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2581
		}
2582
2583
		if ( $mod['module_tags'] ) {
2584
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2585
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2586
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2587
		} else {
2588
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2589
		}
2590
2591 View Code Duplication
		if ( $mod['plan_classes'] ) {
2592
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2593
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2594
		} else {
2595
			$mod['plan_classes'] = array( 'free' );
2596
		}
2597
2598 View Code Duplication
		if ( $mod['feature'] ) {
2599
			$mod['feature'] = explode( ',', $mod['feature'] );
2600
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2601
		} else {
2602
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2603
		}
2604
2605
		/**
2606
		 * Filters the feature array on a module.
2607
		 *
2608
		 * This filter allows you to control where each module is filtered: Recommended,
2609
		 * and the default "Other" listing.
2610
		 *
2611
		 * @since 3.5.0
2612
		 *
2613
		 * @param array   $mod['feature'] The areas to feature this module:
2614
		 *     'Recommended' shows on the main Jetpack admin screen.
2615
		 *     'Other' should be the default if no other value is in the array.
2616
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2617
		 * @param array   $mod All the currently assembled module data.
2618
		 */
2619
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $module.

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...
2620
2621
		/**
2622
		 * Filter the returned data about a module.
2623
		 *
2624
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2625
		 * so please be careful.
2626
		 *
2627
		 * @since 3.6.0
2628
		 *
2629
		 * @param array   $mod    The details of the requested module.
2630
		 * @param string  $module The slug of the module, e.g. sharedaddy
2631
		 * @param string  $file   The path to the module source file.
2632
		 */
2633
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $module.

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...
2634
	}
2635
2636
	/**
2637
	 * Like core's get_file_data implementation, but caches the result.
2638
	 */
2639
	public static function get_file_data( $file, $headers ) {
2640
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2641
		$file_name = basename( $file );
2642
2643
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2644
2645
		$file_data_option = get_transient( $cache_key );
2646
2647
		if ( ! is_array( $file_data_option ) ) {
2648
			delete_transient( $cache_key );
2649
			$file_data_option = false;
2650
		}
2651
2652
		if ( false === $file_data_option ) {
2653
			$file_data_option = array();
2654
		}
2655
2656
		$key           = md5( $file_name . serialize( $headers ) );
2657
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2658
2659
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2660
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2661
			return $file_data_option[ $key ];
2662
		}
2663
2664
		$data = get_file_data( $file, $headers );
2665
2666
		$file_data_option[ $key ] = $data;
2667
2668
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2669
2670
		return $data;
2671
	}
2672
2673
2674
	/**
2675
	 * Return translated module tag.
2676
	 *
2677
	 * @param string $tag Tag as it appears in each module heading.
2678
	 *
2679
	 * @return mixed
2680
	 */
2681
	public static function translate_module_tag( $tag ) {
2682
		return jetpack_get_module_i18n_tag( $tag );
2683
	}
2684
2685
	/**
2686
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2687
	 *
2688
	 * @since 3.9.2
2689
	 *
2690
	 * @param array $modules
2691
	 *
2692
	 * @return string|void
2693
	 */
2694
	public static function get_translated_modules( $modules ) {
2695
		foreach ( $modules as $index => $module ) {
2696
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2697
			if ( isset( $module['name'] ) ) {
2698
				$modules[ $index ]['name'] = $i18n_module['name'];
2699
			}
2700
			if ( isset( $module['description'] ) ) {
2701
				$modules[ $index ]['description']       = $i18n_module['description'];
2702
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2703
			}
2704
		}
2705
		return $modules;
2706
	}
2707
2708
	/**
2709
	 * Get a list of activated modules as an array of module slugs.
2710
	 */
2711
	public static function get_active_modules() {
2712
		$active = Jetpack_Options::get_option( 'active_modules' );
2713
2714
		if ( ! is_array( $active ) ) {
2715
			$active = array();
2716
		}
2717
2718
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2719
			$active[] = 'vaultpress';
2720
		} else {
2721
			$active = array_diff( $active, array( 'vaultpress' ) );
2722
		}
2723
2724
		// If protect is active on the main site of a multisite, it should be active on all sites.
2725
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2726
			$active[] = 'protect';
2727
		}
2728
2729
		/**
2730
		 * Allow filtering of the active modules.
2731
		 *
2732
		 * Gives theme and plugin developers the power to alter the modules that
2733
		 * are activated on the fly.
2734
		 *
2735
		 * @since 5.8.0
2736
		 *
2737
		 * @param array $active Array of active module slugs.
2738
		 */
2739
		$active = apply_filters( 'jetpack_active_modules', $active );
2740
2741
		return array_unique( $active );
2742
	}
2743
2744
	/**
2745
	 * Check whether or not a Jetpack module is active.
2746
	 *
2747
	 * @param string $module The slug of a Jetpack module.
2748
	 * @return bool
2749
	 *
2750
	 * @static
2751
	 */
2752
	public static function is_module_active( $module ) {
2753
		return in_array( $module, self::get_active_modules() );
2754
	}
2755
2756
	public static function is_module( $module ) {
2757
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2758
	}
2759
2760
	/**
2761
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2762
	 *
2763
	 * @param bool $catch True to start catching, False to stop.
2764
	 *
2765
	 * @static
2766
	 */
2767
	public static function catch_errors( $catch ) {
2768
		static $display_errors, $error_reporting;
2769
2770
		if ( $catch ) {
2771
			$display_errors  = @ini_set( 'display_errors', 1 );
2772
			$error_reporting = @error_reporting( E_ALL );
2773
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2774
		} else {
2775
			@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...
2776
			@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...
2777
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2778
		}
2779
	}
2780
2781
	/**
2782
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2783
	 */
2784
	public static function catch_errors_on_shutdown() {
2785
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2786
	}
2787
2788
	/**
2789
	 * Rewrite any string to make paths easier to read.
2790
	 *
2791
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2792
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2793
	 *
2794
	 * @param $string
2795
	 * @return mixed
2796
	 */
2797
	public static function alias_directories( $string ) {
2798
		// ABSPATH has a trailing slash.
2799
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2800
		// WP_CONTENT_DIR does not have a trailing slash.
2801
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2802
2803
		return $string;
2804
	}
2805
2806
	public static function activate_default_modules(
2807
		$min_version = false,
2808
		$max_version = false,
2809
		$other_modules = array(),
2810
		$redirect = null,
2811
		$send_state_messages = null
2812
	) {
2813
		$jetpack = self::init();
2814
2815
		if ( is_null( $redirect ) ) {
2816
			if (
2817
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2818
			||
2819
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2820
			||
2821
				( defined( 'WP_CLI' ) && WP_CLI )
2822
			||
2823
				( defined( 'DOING_CRON' ) && DOING_CRON )
2824
			||
2825
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2826
			) {
2827
				$redirect = false;
2828
			} elseif ( is_admin() ) {
2829
				$redirect = true;
2830
			} else {
2831
				$redirect = false;
2832
			}
2833
		}
2834
2835
		if ( is_null( $send_state_messages ) ) {
2836
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2837
		}
2838
2839
		$modules = self::get_default_modules( $min_version, $max_version );
2840
		$modules = array_merge( $other_modules, $modules );
2841
2842
		// Look for standalone plugins and disable if active.
2843
2844
		$to_deactivate = array();
2845
		foreach ( $modules as $module ) {
2846
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2847
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2848
			}
2849
		}
2850
2851
		$deactivated = array();
2852
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2853
			list( $probable_file, $probable_title ) = $deactivate_me;
2854
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2855
				$deactivated[] = $module;
2856
			}
2857
		}
2858
2859
		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...
2860
			if ( $send_state_messages ) {
2861
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2862
			}
2863
2864
			if ( $redirect ) {
2865
				$url = add_query_arg(
2866
					array(
2867
						'action'   => 'activate_default_modules',
2868
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2869
					),
2870
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2871
				);
2872
				wp_safe_redirect( $url );
2873
				exit;
2874
			}
2875
		}
2876
2877
		/**
2878
		 * Fires before default modules are activated.
2879
		 *
2880
		 * @since 1.9.0
2881
		 *
2882
		 * @param string $min_version Minimum version number required to use modules.
2883
		 * @param string $max_version Maximum version number required to use modules.
2884
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2885
		 */
2886
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2887
2888
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2889
		if ( $send_state_messages ) {
2890
			self::restate();
2891
			self::catch_errors( true );
2892
		}
2893
2894
		$active = self::get_active_modules();
2895
2896
		foreach ( $modules as $module ) {
2897
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2898
				$active[] = $module;
2899
				self::update_active_modules( $active );
2900
				continue;
2901
			}
2902
2903
			if ( $send_state_messages && in_array( $module, $active ) ) {
2904
				$module_info = self::get_module( $module );
2905 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2906
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2907
					if ( $active_state = self::state( $state ) ) {
2908
						$active_state = explode( ',', $active_state );
2909
					} else {
2910
						$active_state = array();
2911
					}
2912
					$active_state[] = $module;
2913
					self::state( $state, implode( ',', $active_state ) );
2914
				}
2915
				continue;
2916
			}
2917
2918
			$file = self::get_module_path( $module );
2919
			if ( ! file_exists( $file ) ) {
2920
				continue;
2921
			}
2922
2923
			// we'll override this later if the plugin can be included without fatal error
2924
			if ( $redirect ) {
2925
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2926
			}
2927
2928
			if ( $send_state_messages ) {
2929
				self::state( 'error', 'module_activation_failed' );
2930
				self::state( 'module', $module );
2931
			}
2932
2933
			ob_start();
2934
			require_once $file;
2935
2936
			$active[] = $module;
2937
2938 View Code Duplication
			if ( $send_state_messages ) {
2939
2940
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2941
				if ( $active_state = self::state( $state ) ) {
2942
					$active_state = explode( ',', $active_state );
2943
				} else {
2944
					$active_state = array();
2945
				}
2946
				$active_state[] = $module;
2947
				self::state( $state, implode( ',', $active_state ) );
2948
			}
2949
2950
			self::update_active_modules( $active );
2951
2952
			ob_end_clean();
2953
		}
2954
2955
		if ( $send_state_messages ) {
2956
			self::state( 'error', false );
0 ignored issues
show
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...
2957
			self::state( 'module', false );
0 ignored issues
show
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...
2958
		}
2959
2960
		self::catch_errors( false );
2961
		/**
2962
		 * Fires when default modules are activated.
2963
		 *
2964
		 * @since 1.9.0
2965
		 *
2966
		 * @param string $min_version Minimum version number required to use modules.
2967
		 * @param string $max_version Maximum version number required to use modules.
2968
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2969
		 */
2970
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2971
	}
2972
2973
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2974
		/**
2975
		 * Fires before a module is activated.
2976
		 *
2977
		 * @since 2.6.0
2978
		 *
2979
		 * @param string $module Module slug.
2980
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2981
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2982
		 */
2983
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2984
2985
		$jetpack = self::init();
2986
2987
		if ( ! strlen( $module ) ) {
2988
			return false;
2989
		}
2990
2991
		if ( ! self::is_module( $module ) ) {
2992
			return false;
2993
		}
2994
2995
		// If it's already active, then don't do it again
2996
		$active = self::get_active_modules();
2997
		foreach ( $active as $act ) {
2998
			if ( $act == $module ) {
2999
				return true;
3000
			}
3001
		}
3002
3003
		$module_data = self::get_module( $module );
3004
3005
		$is_offline_mode = ( new Status() )->is_offline_mode();
3006
		if ( ! self::is_active() ) {
3007
			if ( ! $is_offline_mode && ! self::is_onboarding() ) {
3008
				return false;
3009
			}
3010
3011
			// If we're not connected but in offline mode, make sure the module doesn't require a connection.
3012
			if ( $is_offline_mode && $module_data['requires_connection'] ) {
3013
				return false;
3014
			}
3015
		}
3016
3017
		// Check and see if the old plugin is active
3018
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3019
			// Deactivate the old plugin
3020
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3021
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3022
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3023
				self::state( 'deactivated_plugins', $module );
3024
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3025
				exit;
3026
			}
3027
		}
3028
3029
		// Protect won't work with mis-configured IPs
3030
		if ( 'protect' === $module ) {
3031
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3032
			if ( ! jetpack_protect_get_ip() ) {
3033
				self::state( 'message', 'protect_misconfigured_ip' );
3034
				return false;
3035
			}
3036
		}
3037
3038
		if ( ! Jetpack_Plan::supports( $module ) ) {
3039
			return false;
3040
		}
3041
3042
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3043
		self::state( 'module', $module );
3044
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3045
3046
		self::catch_errors( true );
3047
		ob_start();
3048
		require self::get_module_path( $module );
3049
		/** This action is documented in class.jetpack.php */
3050
		do_action( 'jetpack_activate_module', $module );
3051
		$active[] = $module;
3052
		self::update_active_modules( $active );
3053
3054
		self::state( 'error', false ); // the override
0 ignored issues
show
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...
3055
		ob_end_clean();
3056
		self::catch_errors( false );
3057
3058
		if ( $redirect ) {
3059
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3060
		}
3061
		if ( $exit ) {
3062
			exit;
3063
		}
3064
		return true;
3065
	}
3066
3067
	function activate_module_actions( $module ) {
3068
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3069
	}
3070
3071
	public static function deactivate_module( $module ) {
3072
		/**
3073
		 * Fires when a module is deactivated.
3074
		 *
3075
		 * @since 1.9.0
3076
		 *
3077
		 * @param string $module Module slug.
3078
		 */
3079
		do_action( 'jetpack_pre_deactivate_module', $module );
3080
3081
		$jetpack = self::init();
0 ignored issues
show
$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...
3082
3083
		$active = self::get_active_modules();
3084
		$new    = array_filter( array_diff( $active, (array) $module ) );
3085
3086
		return self::update_active_modules( $new );
3087
	}
3088
3089
	public static function enable_module_configurable( $module ) {
3090
		$module = self::get_module_slug( $module );
3091
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3092
	}
3093
3094
	/**
3095
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3096
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3097
	 *
3098
	 * @param string $module Module slug
3099
	 * @return string $url module configuration URL
3100
	 */
3101
	public static function module_configuration_url( $module ) {
3102
		$module      = self::get_module_slug( $module );
3103
		$default_url = self::admin_url() . "#/settings?term=$module";
3104
		/**
3105
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3106
		 *
3107
		 * @since 6.9.0
3108
		 *
3109
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3110
		 */
3111
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3112
3113
		return $url;
3114
	}
3115
3116
	/* Installation */
3117
	public static function bail_on_activation( $message, $deactivate = true ) {
3118
		?>
3119
<!doctype html>
3120
<html>
3121
<head>
3122
<meta charset="<?php bloginfo( 'charset' ); ?>">
3123
<style>
3124
* {
3125
	text-align: center;
3126
	margin: 0;
3127
	padding: 0;
3128
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3129
}
3130
p {
3131
	margin-top: 1em;
3132
	font-size: 18px;
3133
}
3134
</style>
3135
<body>
3136
<p><?php echo esc_html( $message ); ?></p>
3137
</body>
3138
</html>
3139
		<?php
3140
		if ( $deactivate ) {
3141
			$plugins = get_option( 'active_plugins' );
3142
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3143
			$update  = false;
3144
			foreach ( $plugins as $i => $plugin ) {
3145
				if ( $plugin === $jetpack ) {
3146
					$plugins[ $i ] = false;
3147
					$update        = true;
3148
				}
3149
			}
3150
3151
			if ( $update ) {
3152
				update_option( 'active_plugins', array_filter( $plugins ) );
3153
			}
3154
		}
3155
		exit;
3156
	}
3157
3158
	/**
3159
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3160
	 *
3161
	 * @static
3162
	 */
3163
	public static function plugin_activation( $network_wide ) {
3164
		Jetpack_Options::update_option( 'activated', 1 );
3165
3166
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3167
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3168
		}
3169
3170
		if ( $network_wide ) {
3171
			self::state( 'network_nag', true );
0 ignored issues
show
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...
3172
		}
3173
3174
		// For firing one-off events (notices) immediately after activation
3175
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3176
3177
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3178
3179
		Health::on_jetpack_activated();
3180
3181
		self::plugin_initialize();
3182
	}
3183
3184
	public static function get_activation_source( $referer_url ) {
3185
3186
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3187
			return array( 'wp-cli', null );
3188
		}
3189
3190
		$referer = wp_parse_url( $referer_url );
3191
3192
		$source_type  = 'unknown';
3193
		$source_query = null;
3194
3195
		if ( ! is_array( $referer ) ) {
3196
			return array( $source_type, $source_query );
3197
		}
3198
3199
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_PATH.

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...
3200
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_PATH.

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...
3201
3202
		if ( isset( $referer['query'] ) ) {
3203
			parse_str( $referer['query'], $query_parts );
3204
		} else {
3205
			$query_parts = array();
3206
		}
3207
3208
		if ( $plugins_path === $referer['path'] ) {
3209
			$source_type = 'list';
3210
		} elseif ( $plugins_install_path === $referer['path'] ) {
3211
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3212
			switch ( $tab ) {
3213
				case 'popular':
3214
					$source_type = 'popular';
3215
					break;
3216
				case 'recommended':
3217
					$source_type = 'recommended';
3218
					break;
3219
				case 'favorites':
3220
					$source_type = 'favorites';
3221
					break;
3222
				case 'search':
3223
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3224
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3225
					break;
3226
				default:
3227
					$source_type = 'featured';
3228
			}
3229
		}
3230
3231
		return array( $source_type, $source_query );
3232
	}
3233
3234
	/**
3235
	 * Runs before bumping version numbers up to a new version
3236
	 *
3237
	 * @param string $version    Version:timestamp.
3238
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3239
	 */
3240
	public static function do_version_bump( $version, $old_version ) {
3241
		if ( $old_version ) { // For existing Jetpack installations.
3242
3243
			// If a front end page is visited after the update, the 'wp' action will fire.
3244
			add_action( 'wp', 'Jetpack::set_update_modal_display' );
3245
3246
			// If an admin page is visited after the update, the 'current_screen' action will fire.
3247
			add_action( 'current_screen', 'Jetpack::set_update_modal_display' );
3248
		}
3249
	}
3250
3251
	/**
3252
	 * Sets the display_update_modal state.
3253
	 */
3254
	public static function set_update_modal_display() {
3255
		self::state( 'display_update_modal', true );
0 ignored issues
show
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...
3256
	}
3257
3258
	/**
3259
	 * Sets the internal version number and activation state.
3260
	 *
3261
	 * @static
3262
	 */
3263
	public static function plugin_initialize() {
3264
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3265
			Jetpack_Options::update_option( 'activated', 2 );
3266
		}
3267
3268 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3269
			$version = $old_version = JETPACK__VERSION . ':' . time();
3270
			/** This action is documented in class.jetpack.php */
3271
			do_action( 'updating_jetpack_version', $version, false );
3272
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3273
		}
3274
3275
		self::load_modules();
3276
3277
		Jetpack_Options::delete_option( 'do_activate' );
3278
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3279
	}
3280
3281
	/**
3282
	 * Removes all connection options
3283
	 *
3284
	 * @static
3285
	 */
3286
	public static function plugin_deactivation() {
3287
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3288
		$tracking = new Tracking();
3289
		$tracking->record_user_event( 'deactivate_plugin', array() );
3290
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3291
			Jetpack_Network::init()->deactivate();
3292
		} else {
3293
			self::disconnect( false );
3294
			// Jetpack_Heartbeat::init()->deactivate();
3295
		}
3296
	}
3297
3298
	/**
3299
	 * Disconnects from the Jetpack servers.
3300
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3301
	 *
3302
	 * @static
3303
	 */
3304
	public static function disconnect( $update_activated_state = true ) {
3305
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3306
3307
		$connection = self::connection();
3308
		$connection->clean_nonces( true );
3309
3310
		// If the site is in an IDC because sync is not allowed,
3311
		// let's make sure to not disconnect the production site.
3312
		if ( ! self::validate_sync_error_idc_option() ) {
3313
			$tracking = new Tracking();
3314
			$tracking->record_user_event( 'disconnect_site', array() );
3315
3316
			$connection->disconnect_site_wpcom( true );
3317
		}
3318
3319
		$connection->delete_all_connection_tokens( true );
3320
		Jetpack_IDC::clear_all_idc_options();
3321
3322
		if ( $update_activated_state ) {
3323
			Jetpack_Options::update_option( 'activated', 4 );
3324
		}
3325
3326
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3327
			// Check then record unique disconnection if site has never been disconnected previously
3328
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3329
				$jetpack_unique_connection['disconnected'] = 1;
3330
			} else {
3331
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3332
					// track unique disconnect
3333
					$jetpack = self::init();
3334
3335
					$jetpack->stat( 'connections', 'unique-disconnect' );
3336
					$jetpack->do_stats( 'server_side' );
3337
				}
3338
				// increment number of times disconnected
3339
				$jetpack_unique_connection['disconnected'] += 1;
3340
			}
3341
3342
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3343
		}
3344
3345
		// Delete all the sync related data. Since it could be taking up space.
3346
		Sender::get_instance()->uninstall();
3347
3348
	}
3349
3350
	/**
3351
	 * Unlinks the current user from the linked WordPress.com user.
3352
	 *
3353
	 * @deprecated since 7.7
3354
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3355
	 *
3356
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
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...
3357
	 * @return Boolean Whether the disconnection of the user was successful.
3358
	 */
3359
	public static function unlink_user( $user_id = null ) {
3360
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3361
		return Connection_Manager::disconnect_user( $user_id );
3362
	}
3363
3364
	/**
3365
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3366
	 */
3367
	public static function try_registration() {
3368
		$terms_of_service = new Terms_Of_Service();
3369
		// The user has agreed to the TOS at some point by now.
3370
		$terms_of_service->agree();
3371
3372
		// Let's get some testing in beta versions and such.
3373
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3374
			// Before attempting to connect, let's make sure that the domains are viable.
3375
			$domains_to_check = array_unique(
3376
				array(
3377
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_HOST.

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...
3378
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_HOST.

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...
3379
				)
3380
			);
3381
			foreach ( $domains_to_check as $domain ) {
3382
				$result = self::connection()->is_usable_domain( $domain );
0 ignored issues
show
$domain is of type array<string,string>|false, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3383
				if ( is_wp_error( $result ) ) {
3384
					return $result;
3385
				}
3386
			}
3387
		}
3388
3389
		$result = self::register();
3390
3391
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3392
		if ( ! $result || is_wp_error( $result ) ) {
3393
			return $result;
3394
		} else {
3395
			return true;
3396
		}
3397
	}
3398
3399
	/**
3400
	 * Tracking an internal event log. Try not to put too much chaff in here.
3401
	 *
3402
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3403
	 */
3404
	public static function log( $code, $data = null ) {
3405
		// only grab the latest 200 entries
3406
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3407
3408
		// Append our event to the log
3409
		$log_entry = array(
3410
			'time'    => time(),
3411
			'user_id' => get_current_user_id(),
3412
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3413
			'code'    => $code,
3414
		);
3415
		// Don't bother storing it unless we've got some.
3416
		if ( ! is_null( $data ) ) {
3417
			$log_entry['data'] = $data;
3418
		}
3419
		$log[] = $log_entry;
3420
3421
		// Try add_option first, to make sure it's not autoloaded.
3422
		// @todo: Add an add_option method to Jetpack_Options
3423
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3424
			Jetpack_Options::update_option( 'log', $log );
3425
		}
3426
3427
		/**
3428
		 * Fires when Jetpack logs an internal event.
3429
		 *
3430
		 * @since 3.0.0
3431
		 *
3432
		 * @param array $log_entry {
3433
		 *  Array of details about the log entry.
3434
		 *
3435
		 *  @param string time Time of the event.
3436
		 *  @param int user_id ID of the user who trigerred the event.
3437
		 *  @param int blog_id Jetpack Blog ID.
3438
		 *  @param string code Unique name for the event.
3439
		 *  @param string data Data about the event.
3440
		 * }
3441
		 */
3442
		do_action( 'jetpack_log_entry', $log_entry );
3443
	}
3444
3445
	/**
3446
	 * Get the internal event log.
3447
	 *
3448
	 * @param $event (string) - only return the specific log events
3449
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3450
	 *
3451
	 * @return array of log events || WP_Error for invalid params
3452
	 */
3453
	public static function get_log( $event = false, $num = false ) {
3454
		if ( $event && ! is_string( $event ) ) {
3455
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
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...
3456
		}
3457
3458
		if ( $num && ! is_numeric( $num ) ) {
3459
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
0 ignored issues
show
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...
3460
		}
3461
3462
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3463
3464
		// If nothing set - act as it did before, otherwise let's start customizing the output
3465
		if ( ! $num && ! $event ) {
3466
			return $entire_log;
3467
		} else {
3468
			$entire_log = array_reverse( $entire_log );
3469
		}
3470
3471
		$custom_log_output = array();
3472
3473
		if ( $event ) {
3474
			foreach ( $entire_log as $log_event ) {
3475
				if ( $event == $log_event['code'] ) {
3476
					$custom_log_output[] = $log_event;
3477
				}
3478
			}
3479
		} else {
3480
			$custom_log_output = $entire_log;
3481
		}
3482
3483
		if ( $num ) {
3484
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3485
		}
3486
3487
		return $custom_log_output;
3488
	}
3489
3490
	/**
3491
	 * Log modification of important settings.
3492
	 */
3493
	public static function log_settings_change( $option, $old_value, $value ) {
3494
		switch ( $option ) {
3495
			case 'jetpack_sync_non_public_post_stati':
3496
				self::log( $option, $value );
3497
				break;
3498
		}
3499
	}
3500
3501
	/**
3502
	 * Return stat data for WPCOM sync
3503
	 */
3504
	public static function get_stat_data( $encode = true, $extended = true ) {
3505
		$data = Jetpack_Heartbeat::generate_stats_array();
3506
3507
		if ( $extended ) {
3508
			$additional_data = self::get_additional_stat_data();
3509
			$data            = array_merge( $data, $additional_data );
3510
		}
3511
3512
		if ( $encode ) {
3513
			return json_encode( $data );
3514
		}
3515
3516
		return $data;
3517
	}
3518
3519
	/**
3520
	 * Get additional stat data to sync to WPCOM
3521
	 */
3522
	public static function get_additional_stat_data( $prefix = '' ) {
3523
		$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...
3524
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3525
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3526
		$return[ "{$prefix}site-count" ]    = 0;
3527
3528
		if ( function_exists( 'get_blog_count' ) ) {
3529
			$return[ "{$prefix}site-count" ] = get_blog_count();
3530
		}
3531
		return $return;
3532
	}
3533
3534
	private static function get_site_user_count() {
3535
		global $wpdb;
3536
3537
		if ( function_exists( 'wp_is_large_network' ) ) {
3538
			if ( wp_is_large_network( 'users' ) ) {
3539
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3540
			}
3541
		}
3542
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3543
			// It wasn't there, so regenerate the data and save the transient
3544
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3545
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3546
		}
3547
		return $user_count;
3548
	}
3549
3550
	/* Admin Pages */
3551
3552
	function admin_init() {
3553
		// If the plugin is not connected, display a connect message.
3554
		if (
3555
			// the plugin was auto-activated and needs its candy
3556
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3557
		||
3558
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3559
			! Jetpack_Options::get_option( 'activated' )
3560
		) {
3561
			self::plugin_initialize();
3562
		}
3563
3564
		$is_offline_mode = ( new Status() )->is_offline_mode();
3565
		if ( ! self::is_active() && ! $is_offline_mode ) {
3566
			Jetpack_Connection_Banner::init();
3567
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3568
			// Upgrade: 1.1 -> 1.1.1
3569
			// Check and see if host can verify the Jetpack servers' SSL certificate
3570
			$args       = array();
3571
			$connection = self::connection();
3572
			Client::_wp_remote_request(
3573
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3574
				$args,
3575
				true
3576
			);
3577
		}
3578
3579
		Jetpack_Wizard_Banner::init();
3580
3581
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3582
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3583
		}
3584
3585
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3586
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3587
		add_action( 'admin_enqueue_scripts', array( $this, 'deactivate_dialog' ) );
3588
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3589
3590
		if ( self::is_active() || $is_offline_mode ) {
3591
			// Artificially throw errors in certain specific cases during plugin activation.
3592
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3593
		}
3594
3595
		// Add custom column in wp-admin/users.php to show whether user is linked.
3596
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3597
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3598
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3599
	}
3600
3601
	function admin_body_class( $admin_body_class = '' ) {
3602
		$classes = explode( ' ', trim( $admin_body_class ) );
3603
3604
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3605
3606
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3607
		return " $admin_body_class ";
3608
	}
3609
3610
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3611
		return $admin_body_class . ' jetpack-pagestyles ';
3612
	}
3613
3614
	/**
3615
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3616
	 * This function artificially throws errors for such cases (per a specific list).
3617
	 *
3618
	 * @param string $plugin The activated plugin.
3619
	 */
3620
	function throw_error_on_activate_plugin( $plugin ) {
3621
		$active_modules = self::get_active_modules();
3622
3623
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3624
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3625
			$throw = false;
3626
3627
			// Try and make sure it really was the stats plugin
3628
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3629
				if ( 'stats.php' == basename( $plugin ) ) {
3630
					$throw = true;
3631
				}
3632
			} else {
3633
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3634
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3635
					$throw = true;
3636
				}
3637
			}
3638
3639
			if ( $throw ) {
3640
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3641
			}
3642
		}
3643
	}
3644
3645
	function intercept_plugin_error_scrape_init() {
3646
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3647
	}
3648
3649
	function intercept_plugin_error_scrape( $action, $result ) {
3650
		if ( ! $result ) {
3651
			return;
3652
		}
3653
3654
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3655
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3656
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3657
			}
3658
		}
3659
	}
3660
3661
	/**
3662
	 * Register the remote file upload request handlers, if needed.
3663
	 *
3664
	 * @access public
3665
	 */
3666
	public function add_remote_request_handlers() {
3667
		// Remote file uploads are allowed only via AJAX requests.
3668
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3669
			return;
3670
		}
3671
3672
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3673
		$remote_request_actions = array(
3674
			'jetpack_upload_file',
3675
			'jetpack_update_file',
3676
		);
3677
3678
		// phpcs:ignore WordPress.Security.NonceVerification
3679
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3680
			return;
3681
		}
3682
3683
		// Require Jetpack authentication for the remote file upload AJAX requests.
3684
		if ( ! $this->connection_manager ) {
3685
			$this->connection_manager = new Connection_Manager();
3686
		}
3687
3688
		$this->connection_manager->require_jetpack_authentication();
3689
3690
		// Register the remote file upload AJAX handlers.
3691
		foreach ( $remote_request_actions as $action ) {
3692
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3693
		}
3694
	}
3695
3696
	/**
3697
	 * Handler for Jetpack remote file uploads.
3698
	 *
3699
	 * @access public
3700
	 */
3701
	public function remote_request_handlers() {
3702
		$action = current_filter();
0 ignored issues
show
$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...
3703
3704
		switch ( current_filter() ) {
3705
			case 'wp_ajax_nopriv_jetpack_upload_file':
3706
				$response = $this->upload_handler();
3707
				break;
3708
3709
			case 'wp_ajax_nopriv_jetpack_update_file':
3710
				$response = $this->upload_handler( true );
3711
				break;
3712
			default:
3713
				$response = new WP_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
The call to WP_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...
3714
				break;
3715
		}
3716
3717
		if ( ! $response ) {
3718
			$response = new WP_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
The call to WP_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...
3719
		}
3720
3721
		if ( is_wp_error( $response ) ) {
3722
			$status_code       = $response->get_error_data();
0 ignored issues
show
The method get_error_data() 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...
3723
			$error             = $response->get_error_code();
0 ignored issues
show
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...
3724
			$error_description = $response->get_error_message();
0 ignored issues
show
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...
3725
3726
			if ( ! is_int( $status_code ) ) {
3727
				$status_code = 400;
3728
			}
3729
3730
			status_header( $status_code );
3731
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3732
		}
3733
3734
		status_header( 200 );
3735
		if ( true === $response ) {
3736
			exit;
3737
		}
3738
3739
		die( json_encode( (object) $response ) );
3740
	}
3741
3742
	/**
3743
	 * Uploads a file gotten from the global $_FILES.
3744
	 * If `$update_media_item` is true and `post_id` is defined
3745
	 * the attachment file of the media item (gotten through of the post_id)
3746
	 * will be updated instead of add a new one.
3747
	 *
3748
	 * @param  boolean $update_media_item - update media attachment
3749
	 * @return array - An array describing the uploadind files process
3750
	 */
3751
	function upload_handler( $update_media_item = false ) {
3752
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3753
			return new WP_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
The call to WP_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...
3754
		}
3755
3756
		$user = wp_authenticate( '', '' );
3757
		if ( ! $user || is_wp_error( $user ) ) {
3758
			return new WP_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
The call to WP_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...
3759
		}
3760
3761
		wp_set_current_user( $user->ID );
3762
3763
		if ( ! current_user_can( 'upload_files' ) ) {
3764
			return new WP_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
The call to WP_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...
3765
		}
3766
3767
		if ( empty( $_FILES ) ) {
3768
			return new WP_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
The call to WP_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...
3769
		}
3770
3771
		foreach ( array_keys( $_FILES ) as $files_key ) {
3772
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3773
				return new WP_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
The call to WP_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...
3774
			}
3775
		}
3776
3777
		$media_keys = array_keys( $_FILES['media'] );
3778
3779
		$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...
3780
		if ( ! $token || is_wp_error( $token ) ) {
3781
			return new WP_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
The call to WP_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...
3782
		}
3783
3784
		$uploaded_files = array();
3785
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3786
		unset( $GLOBALS['post'] );
3787
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3788
			$file = array();
3789
			foreach ( $media_keys as $media_key ) {
3790
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3791
			}
3792
3793
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3794
3795
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3796
			if ( $hmac_provided !== $hmac_file ) {
3797
				$uploaded_files[ $index ] = (object) array(
3798
					'error'             => 'invalid_hmac',
3799
					'error_description' => 'The corresponding HMAC for this file does not match',
3800
				);
3801
				continue;
3802
			}
3803
3804
			$_FILES['.jetpack.upload.'] = $file;
3805
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3806
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3807
				$post_id = 0;
3808
			}
3809
3810
			if ( $update_media_item ) {
3811
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3812
					return new WP_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
The call to WP_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...
3813
				}
3814
3815
				$media_array = $_FILES['media'];
3816
3817
				$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...
3818
				$file_array['type']     = $media_array['type'][0];
3819
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3820
				$file_array['error']    = $media_array['error'][0];
3821
				$file_array['size']     = $media_array['size'][0];
3822
3823
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3824
3825
				if ( is_wp_error( $edited_media_item ) ) {
3826
					return $edited_media_item;
3827
				}
3828
3829
				$response = (object) array(
3830
					'id'   => (string) $post_id,
3831
					'file' => (string) $edited_media_item->post_title,
3832
					'url'  => (string) wp_get_attachment_url( $post_id ),
3833
					'type' => (string) $edited_media_item->post_mime_type,
3834
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3835
				);
3836
3837
				return (array) array( $response );
3838
			}
3839
3840
			$attachment_id = media_handle_upload(
3841
				'.jetpack.upload.',
3842
				$post_id,
3843
				array(),
3844
				array(
3845
					'action' => 'jetpack_upload_file',
3846
				)
3847
			);
3848
3849
			if ( ! $attachment_id ) {
3850
				$uploaded_files[ $index ] = (object) array(
3851
					'error'             => 'unknown',
3852
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3853
				);
3854
			} elseif ( is_wp_error( $attachment_id ) ) {
3855
				$uploaded_files[ $index ] = (object) array(
3856
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3857
					'error_description' => $attachment_id->get_error_message(),
3858
				);
3859
			} else {
3860
				$attachment               = get_post( $attachment_id );
3861
				$uploaded_files[ $index ] = (object) array(
3862
					'id'   => (string) $attachment_id,
3863
					'file' => $attachment->post_title,
3864
					'url'  => wp_get_attachment_url( $attachment_id ),
3865
					'type' => $attachment->post_mime_type,
3866
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3867
				);
3868
				// Zip files uploads are not supported unless they are done for installation purposed
3869
				// lets delete them in case something goes wrong in this whole process
3870
				if ( 'application/zip' === $attachment->post_mime_type ) {
3871
					// Schedule a cleanup for 2 hours from now in case of failed install.
3872
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3873
				}
3874
			}
3875
		}
3876
		if ( ! is_null( $global_post ) ) {
3877
			$GLOBALS['post'] = $global_post;
3878
		}
3879
3880
		return $uploaded_files;
3881
	}
3882
3883
	/**
3884
	 * Add help to the Jetpack page
3885
	 *
3886
	 * @since Jetpack (1.2.3)
3887
	 * @return false if not the Jetpack page
3888
	 */
3889
	function admin_help() {
3890
		$current_screen = get_current_screen();
3891
3892
		// Overview
3893
		$current_screen->add_help_tab(
3894
			array(
3895
				'id'      => 'home',
3896
				'title'   => __( 'Home', 'jetpack' ),
3897
				'content' =>
3898
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3899
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3900
					'<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>',
3901
			)
3902
		);
3903
3904
		// Screen Content
3905
		if ( current_user_can( 'manage_options' ) ) {
3906
			$current_screen->add_help_tab(
3907
				array(
3908
					'id'      => 'settings',
3909
					'title'   => __( 'Settings', 'jetpack' ),
3910
					'content' =>
3911
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3912
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3913
						'<ol>' .
3914
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3915
							'<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>' .
3916
						'</ol>' .
3917
						'<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>',
3918
				)
3919
			);
3920
		}
3921
3922
		// Help Sidebar
3923
		$support_url = Redirect::get_url( 'jetpack-support' );
3924
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
3925
		$current_screen->set_help_sidebar(
3926
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3927
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3928
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3929
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3930
		);
3931
	}
3932
3933
	function admin_menu_css() {
3934
		wp_enqueue_style( 'jetpack-icons' );
3935
	}
3936
3937
	function admin_menu_order() {
3938
		return true;
3939
	}
3940
3941 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3942
		$jp_menu_order = array();
3943
3944
		foreach ( $menu_order as $index => $item ) {
3945
			if ( $item != 'jetpack' ) {
3946
				$jp_menu_order[] = $item;
3947
			}
3948
3949
			if ( $index == 0 ) {
3950
				$jp_menu_order[] = 'jetpack';
3951
			}
3952
		}
3953
3954
		return $jp_menu_order;
3955
	}
3956
3957
	function admin_banner_styles() {
3958
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3959
3960 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3961
			wp_register_style(
3962
				'jetpack-dops-style',
3963
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3964
				array(),
3965
				JETPACK__VERSION
3966
			);
3967
		}
3968
3969
		wp_enqueue_style(
3970
			'jetpack',
3971
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3972
			array( 'jetpack-dops-style' ),
3973
			JETPACK__VERSION . '-20121016'
3974
		);
3975
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3976
		wp_style_add_data( 'jetpack', 'suffix', $min );
3977
	}
3978
3979
	function plugin_action_links( $actions ) {
3980
3981
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3982
3983
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_offline_mode() ) ) {
3984
			return array_merge(
3985
				$jetpack_home,
3986
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3987
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3988
				$actions
3989
			);
3990
		}
3991
3992
		return array_merge( $jetpack_home, $actions );
3993
	}
3994
3995
	/**
3996
	 * Adds the deactivation warning modal if there are other active plugins using the connection
3997
	 *
3998
	 * @param string $hook The current admin page.
3999
	 *
4000
	 * @return void
4001
	 */
4002
	public function deactivate_dialog( $hook ) {
4003
		if (
4004
			'plugins.php' === $hook
4005
			&& self::is_active()
4006
		) {
4007
4008
			$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4009
4010
			if ( count( $active_plugins_using_connection ) > 1 ) {
4011
4012
				add_thickbox();
4013
4014
				wp_register_script(
4015
					'jp-tracks',
4016
					'//stats.wp.com/w.js',
4017
					array(),
4018
					gmdate( 'YW' ),
4019
					true
4020
				);
4021
4022
				wp_register_script(
4023
					'jp-tracks-functions',
4024
					plugins_url( '_inc/lib/tracks/tracks-callables.js', JETPACK__PLUGIN_FILE ),
4025
					array( 'jp-tracks' ),
4026
					JETPACK__VERSION,
4027
					false
4028
				);
4029
4030
				wp_enqueue_script(
4031
					'jetpack-deactivate-dialog-js',
4032
					Assets::get_file_url_for_environment(
4033
						'_inc/build/jetpack-deactivate-dialog.min.js',
4034
						'_inc/jetpack-deactivate-dialog.js'
4035
					),
4036
					array( 'jquery', 'jp-tracks-functions' ),
4037
					JETPACK__VERSION,
4038
					true
4039
				);
4040
4041
				wp_localize_script(
4042
					'jetpack-deactivate-dialog-js',
4043
					'deactivate_dialog',
4044
					array(
4045
						'title'            => __( 'Deactivate Jetpack', 'jetpack' ),
4046
						'deactivate_label' => __( 'Disconnect and Deactivate', 'jetpack' ),
4047
						'tracksUserData'   => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
4048
					)
4049
				);
4050
4051
				add_action( 'admin_footer', array( $this, 'deactivate_dialog_content' ) );
4052
4053
				wp_enqueue_style( 'jetpack-deactivate-dialog', plugins_url( 'css/jetpack-deactivate-dialog.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
4054
			}
4055
		}
4056
	}
4057
4058
	/**
4059
	 * Outputs the content of the deactivation modal
4060
	 *
4061
	 * @return void
4062
	 */
4063
	public function deactivate_dialog_content() {
4064
		$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4065
		unset( $active_plugins_using_connection['jetpack'] );
4066
		$this->load_view( 'admin/deactivation-dialog.php', $active_plugins_using_connection );
0 ignored issues
show
It seems like $active_plugins_using_connection defined by \Automattic\Jetpack\Conn...ugin_Storage::get_all() on line 4064 can also be of type object<WP_Error>; however, Jetpack::load_view() does only seem to accept array, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
4067
	}
4068
4069
	/**
4070
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4071
	 *
4072
	 * @param string $login_url The wp-login URL.
4073
	 * @param string $redirect  URL to redirect users after logging in.
4074
	 * @since Jetpack 8.4
4075
	 * @return string
4076
	 */
4077
	public function login_url( $login_url, $redirect ) {
4078
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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...
4079
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4080
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4081
		}
4082
		return $login_url;
4083
	}
4084
4085
	/**
4086
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4087
	 *
4088
	 * @since Jetpack 8.4
4089
	 */
4090
	public function login_init() {
4091
		// phpcs:ignore WordPress.Security.NonceVerification
4092
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4093
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4094
			wp_safe_redirect(
4095
				add_query_arg(
4096
					array(
4097
						'forceInstall' => 1,
4098
						'url'          => rawurlencode( get_site_url() ),
4099
					),
4100
					// @todo provide way to go to specific calypso env.
4101
					self::get_calypso_host() . 'jetpack/connect'
4102
				)
4103
			);
4104
			exit;
4105
		}
4106
	}
4107
4108
	/*
4109
	 * Registration flow:
4110
	 * 1 - ::admin_page_load() action=register
4111
	 * 2 - ::try_registration()
4112
	 * 3 - ::register()
4113
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4114
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4115
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4116
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4117
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4118
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4119
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4120
	 *       jetpack_id, jetpack_secret, jetpack_public
4121
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4122
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4123
	 * 5 - user logs in with WP.com account
4124
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4125
	 *		- Manager::authorize()
4126
	 *		- Manager::get_token()
4127
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4128
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4129
	 *			- which responds with access_token, token_type, scope
4130
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4131
	 *		- Jetpack::activate_default_modules()
4132
	 *     		- Deactivates deprecated plugins
4133
	 *     		- Activates all default modules
4134
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4135
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4136
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4137
	 *     Done!
4138
	 */
4139
4140
	/**
4141
	 * Handles the page load events for the Jetpack admin page
4142
	 */
4143
	function admin_page_load() {
4144
		$error = false;
4145
4146
		// Make sure we have the right body class to hook stylings for subpages off of.
4147
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4148
4149
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4150
			// Should only be used in intermediate redirects to preserve state across redirects
4151
			self::restate();
4152
		}
4153
4154
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4155
			// @todo: Add validation against a known allowed list.
4156
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4157
			// User clicked in the iframe to link their accounts
4158
			if ( ! self::is_user_connected() ) {
4159
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4160
4161
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4162
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4163
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4164
4165
				if ( isset( $_GET['notes_iframe'] ) ) {
4166
					$connect_url .= '&notes_iframe';
4167
				}
4168
				wp_redirect( $connect_url );
4169
				exit;
4170
			} else {
4171
				if ( ! isset( $_GET['calypso_env'] ) ) {
4172
					self::state( 'message', 'already_authorized' );
4173
					wp_safe_redirect( self::admin_url() );
4174
					exit;
4175
				} else {
4176
					$connect_url  = $this->build_connect_url( true, false, $from );
4177
					$connect_url .= '&already_authorized=true';
4178
					wp_redirect( $connect_url );
4179
					exit;
4180
				}
4181
			}
4182
		}
4183
4184
		if ( isset( $_GET['action'] ) ) {
4185
			switch ( $_GET['action'] ) {
4186
				case 'authorize':
4187
					if ( self::is_active() && self::is_user_connected() ) {
4188
						self::state( 'message', 'already_authorized' );
4189
						wp_safe_redirect( self::admin_url() );
4190
						exit;
4191
					}
4192
					self::log( 'authorize' );
4193
					$client_server = new Jetpack_Client_Server();
4194
					$client_server->client_authorize();
4195
					exit;
4196
				case 'register':
4197
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4198
						$error = 'cheatin';
4199
						break;
4200
					}
4201
					check_admin_referer( 'jetpack-register' );
4202
					self::log( 'register' );
4203
					self::maybe_set_version_option();
4204
					$registered = self::try_registration();
4205 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4206
						$error = $registered->get_error_code();
0 ignored issues
show
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...
4207
						self::state( 'error', $error );
4208
						self::state( 'error', $registered->get_error_message() );
0 ignored issues
show
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...
4209
4210
						/**
4211
						 * Jetpack registration Error.
4212
						 *
4213
						 * @since 7.5.0
4214
						 *
4215
						 * @param string|int $error The error code.
4216
						 * @param \WP_Error $registered The error object.
4217
						 */
4218
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4219
						break;
4220
					}
4221
4222
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4223
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4224
4225
					/**
4226
					 * Jetpack registration Success.
4227
					 *
4228
					 * @since 7.5.0
4229
					 *
4230
					 * @param string $from 'from' GET parameter;
4231
					 */
4232
					do_action( 'jetpack_connection_register_success', $from );
4233
4234
					$url = $this->build_connect_url( true, $redirect, $from );
4235
4236
					if ( ! empty( $_GET['onboarding'] ) ) {
4237
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4238
					}
4239
4240
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4241
						$url = add_query_arg( 'auth_approved', 'true', $url );
4242
					}
4243
4244
					wp_redirect( $url );
4245
					exit;
4246
				case 'activate':
4247
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4248
						$error = 'cheatin';
4249
						break;
4250
					}
4251
4252
					$module = stripslashes( $_GET['module'] );
4253
					check_admin_referer( "jetpack_activate-$module" );
4254
					self::log( 'activate', $module );
4255
					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...
4256
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4257
					}
4258
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4259
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4260
					exit;
4261
				case 'activate_default_modules':
4262
					check_admin_referer( 'activate_default_modules' );
4263
					self::log( 'activate_default_modules' );
4264
					self::restate();
4265
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4266
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4267
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4268
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4269
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4270
					exit;
4271
				case 'disconnect':
4272
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4273
						$error = 'cheatin';
4274
						break;
4275
					}
4276
4277
					check_admin_referer( 'jetpack-disconnect' );
4278
					self::log( 'disconnect' );
4279
					self::disconnect();
4280
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4281
					exit;
4282
				case 'reconnect':
4283
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4284
						$error = 'cheatin';
4285
						break;
4286
					}
4287
4288
					check_admin_referer( 'jetpack-reconnect' );
4289
					self::log( 'reconnect' );
4290
					$this->disconnect();
4291
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4292
					exit;
4293 View Code Duplication
				case 'deactivate':
4294
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4295
						$error = 'cheatin';
4296
						break;
4297
					}
4298
4299
					$modules = stripslashes( $_GET['module'] );
4300
					check_admin_referer( "jetpack_deactivate-$modules" );
4301
					foreach ( explode( ',', $modules ) as $module ) {
4302
						self::log( 'deactivate', $module );
4303
						self::deactivate_module( $module );
4304
						self::state( 'message', 'module_deactivated' );
4305
					}
4306
					self::state( 'module', $modules );
4307
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4308
					exit;
4309
				case 'unlink':
4310
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4311
					check_admin_referer( 'jetpack-unlink' );
4312
					self::log( 'unlink' );
4313
					Connection_Manager::disconnect_user();
4314
					self::state( 'message', 'unlinked' );
4315
					if ( 'sub-unlink' == $redirect ) {
4316
						wp_safe_redirect( admin_url() );
4317
					} else {
4318
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4319
					}
4320
					exit;
4321
				case 'onboard':
4322
					if ( ! current_user_can( 'manage_options' ) ) {
4323
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4324
					} else {
4325
						self::create_onboarding_token();
4326
						$url = $this->build_connect_url( true );
4327
4328
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4329
							$url = add_query_arg( 'onboarding', $token, $url );
4330
						}
4331
4332
						$calypso_env = $this->get_calypso_env();
4333
						if ( ! empty( $calypso_env ) ) {
4334
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4335
						}
4336
4337
						wp_redirect( $url );
4338
						exit;
4339
					}
4340
					exit;
4341
				default:
4342
					/**
4343
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4344
					 *
4345
					 * @since 2.6.0
4346
					 *
4347
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4348
					 */
4349
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4350
			}
4351
		}
4352
4353
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4354
			self::activate_new_modules( true );
4355
		}
4356
4357
		$message_code = self::state( 'message' );
4358
		if ( self::state( 'optin-manage' ) ) {
4359
			$activated_manage = $message_code;
4360
			$message_code     = 'jetpack-manage';
4361
		}
4362
4363
		switch ( $message_code ) {
4364
			case 'jetpack-manage':
4365
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4366
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4367
				$this->message = '<strong>' . sprintf( __( 'You are all set! Your site can now be managed from <a href="%s" target="_blank">wordpress.com/sites</a>.', 'jetpack' ), $sites_url ) . '</strong>';
4368
				if ( $activated_manage ) {
0 ignored issues
show
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...
4369
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4370
				}
4371
				break;
4372
4373
		}
4374
4375
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4376
4377
		if ( ! empty( $deactivated_plugins ) ) {
4378
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4379
			$deactivated_titles  = array();
4380
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4381
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4382
					continue;
4383
				}
4384
4385
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4386
			}
4387
4388
			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...
4389
				if ( $this->message ) {
4390
					$this->message .= "<br /><br />\n";
4391
				}
4392
4393
				$this->message .= wp_sprintf(
4394
					_n(
4395
						'Jetpack contains the most recent version of the old %l plugin.',
4396
						'Jetpack contains the most recent versions of the old %l plugins.',
4397
						count( $deactivated_titles ),
4398
						'jetpack'
4399
					),
4400
					$deactivated_titles
4401
				);
4402
4403
				$this->message .= "<br />\n";
4404
4405
				$this->message .= _n(
4406
					'The old version has been deactivated and can be removed from your site.',
4407
					'The old versions have been deactivated and can be removed from your site.',
4408
					count( $deactivated_titles ),
4409
					'jetpack'
4410
				);
4411
			}
4412
		}
4413
4414
		$this->privacy_checks = self::state( 'privacy_checks' );
4415
4416
		if ( $this->message || $this->error || $this->privacy_checks ) {
4417
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4418
		}
4419
4420
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4421
	}
4422
4423
	function admin_notices() {
4424
4425
		if ( $this->error ) {
4426
			?>
4427
<div id="message" class="jetpack-message jetpack-err">
4428
	<div class="squeezer">
4429
		<h2>
4430
			<?php
4431
			echo wp_kses(
4432
				$this->error,
4433
				array(
4434
					'a'      => array( 'href' => array() ),
4435
					'small'  => true,
4436
					'code'   => true,
4437
					'strong' => true,
4438
					'br'     => true,
4439
					'b'      => true,
4440
				)
4441
			);
4442
			?>
4443
			</h2>
4444
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4445
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4446
<?php	endif; ?>
4447
	</div>
4448
</div>
4449
			<?php
4450
		}
4451
4452
		if ( $this->message ) {
4453
			?>
4454
<div id="message" class="jetpack-message">
4455
	<div class="squeezer">
4456
		<h2>
4457
			<?php
4458
			echo wp_kses(
4459
				$this->message,
4460
				array(
4461
					'strong' => array(),
4462
					'a'      => array( 'href' => true ),
4463
					'br'     => true,
4464
				)
4465
			);
4466
			?>
4467
			</h2>
4468
	</div>
4469
</div>
4470
			<?php
4471
		}
4472
4473
		if ( $this->privacy_checks ) :
4474
			$module_names = $module_slugs = array();
4475
4476
			$privacy_checks = explode( ',', $this->privacy_checks );
4477
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4478
			foreach ( $privacy_checks as $module_slug ) {
4479
				$module = self::get_module( $module_slug );
4480
				if ( ! $module ) {
4481
					continue;
4482
				}
4483
4484
				$module_slugs[] = $module_slug;
4485
				$module_names[] = "<strong>{$module['name']}</strong>";
4486
			}
4487
4488
			$module_slugs = join( ',', $module_slugs );
4489
			?>
4490
<div id="message" class="jetpack-message jetpack-err">
4491
	<div class="squeezer">
4492
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4493
		<p>
4494
			<?php
4495
			echo wp_kses(
4496
				wptexturize(
4497
					wp_sprintf(
4498
						_nx(
4499
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4500
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4501
							count( $privacy_checks ),
4502
							'%l = list of Jetpack module/feature names',
4503
							'jetpack'
4504
						),
4505
						$module_names
4506
					)
4507
				),
4508
				array( 'strong' => true )
4509
			);
4510
4511
			echo "\n<br />\n";
4512
4513
			echo wp_kses(
4514
				sprintf(
4515
					_nx(
4516
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4517
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4518
						count( $privacy_checks ),
4519
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4520
						'jetpack'
4521
					),
4522
					wp_nonce_url(
4523
						self::admin_url(
4524
							array(
4525
								'page'   => 'jetpack',
4526
								'action' => 'deactivate',
4527
								'module' => urlencode( $module_slugs ),
4528
							)
4529
						),
4530
						"jetpack_deactivate-$module_slugs"
4531
					),
4532
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4533
				),
4534
				array(
4535
					'a' => array(
4536
						'href'  => true,
4537
						'title' => true,
4538
					),
4539
				)
4540
			);
4541
			?>
4542
		</p>
4543
	</div>
4544
</div>
4545
			<?php
4546
endif;
4547
	}
4548
4549
	/**
4550
	 * We can't always respond to a signed XML-RPC request with a
4551
	 * helpful error message. In some circumstances, doing so could
4552
	 * leak information.
4553
	 *
4554
	 * Instead, track that the error occurred via a Jetpack_Option,
4555
	 * and send that data back in the heartbeat.
4556
	 * All this does is increment a number, but it's enough to find
4557
	 * trends.
4558
	 *
4559
	 * @param WP_Error $xmlrpc_error The error produced during
4560
	 *                               signature validation.
4561
	 */
4562
	function track_xmlrpc_error( $xmlrpc_error ) {
4563
		$code = is_wp_error( $xmlrpc_error )
4564
			? $xmlrpc_error->get_error_code()
0 ignored issues
show
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...
4565
			: 'should-not-happen';
4566
4567
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4568
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4569
			// No need to update the option if we already have
4570
			// this code stored.
4571
			return;
4572
		}
4573
		$xmlrpc_errors[ $code ] = true;
4574
4575
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
0 ignored issues
show
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...
4576
	}
4577
4578
	/**
4579
	 * Initialize the jetpack stats instance only when needed
4580
	 *
4581
	 * @return void
4582
	 */
4583
	private function initialize_stats() {
4584
		if ( is_null( $this->a8c_mc_stats_instance ) ) {
4585
			$this->a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4586
		}
4587
	}
4588
4589
	/**
4590
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4591
	 */
4592
	function stat( $group, $detail ) {
4593
		$this->initialize_stats();
4594
		$this->a8c_mc_stats_instance->add( $group, $detail );
4595
4596
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4597
		$this->stats = $this->a8c_mc_stats_instance->get_current_stats();
4598
	}
4599
4600
	/**
4601
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4602
	 */
4603
	function do_stats( $method = '' ) {
4604
		$this->initialize_stats();
4605
		if ( 'server_side' === $method ) {
4606
			$this->a8c_mc_stats_instance->do_server_side_stats();
4607
		} else {
4608
			$this->a8c_mc_stats_instance->do_stats();
4609
		}
4610
4611
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4612
		$this->stats = array();
4613
	}
4614
4615
	/**
4616
	 * Runs stats code for a one-off, server-side.
4617
	 *
4618
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4619
	 *
4620
	 * @return bool If it worked.
4621
	 */
4622
	static function do_server_side_stat( $args ) {
4623
		$url                   = self::build_stats_url( $args );
4624
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4625
		return $a8c_mc_stats_instance->do_server_side_stat( $url );
4626
	}
4627
4628
	/**
4629
	 * Builds the stats url.
4630
	 *
4631
	 * @param $args array|string The arguments to append to the URL.
4632
	 *
4633
	 * @return string The URL to be pinged.
4634
	 */
4635
	static function build_stats_url( $args ) {
4636
4637
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4638
		return $a8c_mc_stats_instance->build_stats_url( $args );
4639
4640
	}
4641
4642
	/**
4643
	 * Get the role of the current user.
4644
	 *
4645
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4646
	 *
4647
	 * @access public
4648
	 * @static
4649
	 *
4650
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4651
	 */
4652
	public static function translate_current_user_to_role() {
4653
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4654
4655
		$roles = new Roles();
4656
		return $roles->translate_current_user_to_role();
4657
	}
4658
4659
	/**
4660
	 * Get the role of a particular user.
4661
	 *
4662
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4663
	 *
4664
	 * @access public
4665
	 * @static
4666
	 *
4667
	 * @param \WP_User $user User object.
4668
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4669
	 */
4670
	public static function translate_user_to_role( $user ) {
4671
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4672
4673
		$roles = new Roles();
4674
		return $roles->translate_user_to_role( $user );
4675
	}
4676
4677
	/**
4678
	 * Get the minimum capability for a role.
4679
	 *
4680
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4681
	 *
4682
	 * @access public
4683
	 * @static
4684
	 *
4685
	 * @param string $role Role name.
4686
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4687
	 */
4688
	public static function translate_role_to_cap( $role ) {
4689
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4690
4691
		$roles = new Roles();
4692
		return $roles->translate_role_to_cap( $role );
4693
	}
4694
4695
	/**
4696
	 * Sign a user role with the master access token.
4697
	 * If not specified, will default to the current user.
4698
	 *
4699
	 * @deprecated since 7.7
4700
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4701
	 *
4702
	 * @access public
4703
	 * @static
4704
	 *
4705
	 * @param string $role    User role.
4706
	 * @param int    $user_id ID of the user.
0 ignored issues
show
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...
4707
	 * @return string Signed user role.
4708
	 */
4709
	public static function sign_role( $role, $user_id = null ) {
4710
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4711
		return self::connection()->sign_role( $role, $user_id );
4712
	}
4713
4714
	/**
4715
	 * Builds a URL to the Jetpack connection auth page
4716
	 *
4717
	 * @since 3.9.5
4718
	 *
4719
	 * @param bool        $raw If true, URL will not be escaped.
4720
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4721
	 *                              If string, will be a custom redirect.
4722
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4723
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4724
	 *
4725
	 * @return string Connect URL
4726
	 */
4727
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4728
		$site_id    = Jetpack_Options::get_option( 'id' );
4729
		$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...
4730
4731
		if ( $register || ! $blog_token || ! $site_id ) {
4732
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4733
4734
			if ( ! empty( $redirect ) ) {
4735
				$url = add_query_arg(
4736
					'redirect',
4737
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4738
					$url
4739
				);
4740
			}
4741
4742
			if ( is_network_admin() ) {
4743
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4744
			}
4745
4746
			$calypso_env = self::get_calypso_env();
4747
4748
			if ( ! empty( $calypso_env ) ) {
4749
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4750
			}
4751
		} else {
4752
4753
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4754
			// because otherwise this logic can get us in to a loop.
4755
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4756
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4757
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4758
4759
				$response = Client::wpcom_json_api_request_as_blog(
4760
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4761
					'1.1'
4762
				);
4763
4764
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4765
4766
					// Generating a register URL instead to refresh the existing token
4767
					return $this->build_connect_url( $raw, $redirect, $from, true );
4768
				}
4769
			}
4770
4771
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
It seems like $redirect defined by parameter $redirect on line 4727 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...
4772
		}
4773
4774
		if ( $from ) {
4775
			$url = add_query_arg( 'from', $from, $url );
4776
		}
4777
4778
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4779
		/**
4780
		 * Filter the URL used when connecting a user to a WordPress.com account.
4781
		 *
4782
		 * @since 8.1.0
4783
		 *
4784
		 * @param string $url Connection URL.
4785
		 * @param bool   $raw If true, URL will not be escaped.
4786
		 */
4787
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $raw.

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...
4788
	}
4789
4790
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4791
4792
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4793
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4794
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4795
4796
		if ( $iframe ) {
4797
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4798
		}
4799
4800
		$c8n = self::connection();
4801
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
0 ignored issues
show
$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...
4802
4803
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4804
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4805
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4806
4807
		if ( $iframe ) {
4808
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4809
		}
4810
4811
		/**
4812
		 * Filter the URL used when authorizing a user to a WordPress.com account.
4813
		 *
4814
		 * @since 8.9.0
4815
		 *
4816
		 * @param string $url Connection URL.
4817
		 */
4818
		return apply_filters( 'jetpack_build_authorize_url', $url );
4819
	}
4820
4821
	/**
4822
	 * Filters the connection URL parameter array.
4823
	 *
4824
	 * @param array $args default URL parameters used by the package.
4825
	 * @return array the modified URL arguments array.
4826
	 */
4827
	public static function filter_connect_request_body( $args ) {
4828
		if (
4829
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4830
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4831
		) {
4832
			$gp_locale      = GP_Locales::by_field( 'wp_locale', get_locale() );
4833
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4834
				? $gp_locale->slug
4835
				: '';
4836
		}
4837
4838
		$tracking        = new Tracking();
4839
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4840
4841
		$args = array_merge(
4842
			$args,
4843
			array(
4844
				'_ui' => $tracks_identity['_ui'],
4845
				'_ut' => $tracks_identity['_ut'],
4846
			)
4847
		);
4848
4849
		$calypso_env = self::get_calypso_env();
4850
4851
		if ( ! empty( $calypso_env ) ) {
4852
			$args['calypso_env'] = $calypso_env;
4853
		}
4854
4855
		return $args;
4856
	}
4857
4858
	/**
4859
	 * Filters the URL that will process the connection data. It can be different from the URL
4860
	 * that we send the user to after everything is done.
4861
	 *
4862
	 * @param String $processing_url the default redirect URL used by the package.
4863
	 * @return String the modified URL.
4864
	 */
4865
	public static function filter_connect_processing_url( $processing_url ) {
4866
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4867
		return $processing_url;
4868
	}
4869
4870
	/**
4871
	 * Filters the redirection URL that is used for connect requests. The redirect
4872
	 * URL should return the user back to the Jetpack console.
4873
	 *
4874
	 * @param String $redirect the default redirect URL used by the package.
4875
	 * @return String the modified URL.
4876
	 */
4877
	public static function filter_connect_redirect_url( $redirect ) {
4878
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4879
		$redirect           = $redirect
4880
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4881
			: $jetpack_admin_page;
4882
4883
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4884
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4885
		}
4886
4887
		return $redirect;
4888
	}
4889
4890
	/**
4891
	 * This action fires at the beginning of the Manager::authorize method.
4892
	 */
4893
	public static function authorize_starting() {
4894
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4895
		// Checking if site has been active/connected previously before recording unique connection.
4896
		if ( ! $jetpack_unique_connection ) {
4897
			// jetpack_unique_connection option has never been set.
4898
			$jetpack_unique_connection = array(
4899
				'connected'    => 0,
4900
				'disconnected' => 0,
4901
				'version'      => '3.6.1',
4902
			);
4903
4904
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4905
4906
			// Track unique connection.
4907
			$jetpack = self::init();
4908
4909
			$jetpack->stat( 'connections', 'unique-connection' );
4910
			$jetpack->do_stats( 'server_side' );
4911
		}
4912
4913
		// Increment number of times connected.
4914
		$jetpack_unique_connection['connected'] += 1;
4915
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4916
	}
4917
4918
	/**
4919
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4920
	 * linked.
4921
	 */
4922
	public static function authorize_ending_linked() {
4923
		// Don't activate anything since we are just connecting a user.
4924
		self::state( 'message', 'linked' );
4925
	}
4926
4927
	/**
4928
	 * This action fires at the end of the Manager::authorize method when the master user is
4929
	 * authorized.
4930
	 *
4931
	 * @param array $data The request data.
4932
	 */
4933
	public static function authorize_ending_authorized( $data ) {
4934
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4935
		self::invalidate_onboarding_token();
4936
4937
		// If redirect_uri is SSO, ensure SSO module is enabled.
4938
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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...
4939
4940
		/** This filter is documented in class.jetpack-cli.php */
4941
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4942
4943
		$activate_sso = (
4944
			isset( $redirect_options['action'] ) &&
4945
			'jetpack-sso' === $redirect_options['action'] &&
4946
			$jetpack_start_enable_sso
4947
		);
4948
4949
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4950
4951
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4952
	}
4953
4954
	/**
4955
	 * This action fires at the end of the REST_Connector connection_reconnect method when the
4956
	 * reconnect process is completed.
4957
	 * Note that this currently only happens when we don't need the user to re-authorize
4958
	 * their WP.com account, eg in cases where we are restoring a connection with
4959
	 * unhealthy blog token.
4960
	 */
4961
	public static function reconnection_completed() {
4962
		self::state( 'message', 'reconnection_completed' );
4963
	}
4964
4965
	/**
4966
	 * Get our assumed site creation date.
4967
	 * Calculated based on the earlier date of either:
4968
	 * - Earliest admin user registration date.
4969
	 * - Earliest date of post of any post type.
4970
	 *
4971
	 * @since 7.2.0
4972
	 * @deprecated since 7.8.0
4973
	 *
4974
	 * @return string Assumed site creation date and time.
4975
	 */
4976
	public static function get_assumed_site_creation_date() {
4977
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4978
		return self::connection()->get_assumed_site_creation_date();
4979
	}
4980
4981 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4982
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4983
4984
		if ( $activation_source_name ) {
4985
			$args['_as'] = urlencode( $activation_source_name );
4986
		}
4987
4988
		if ( $activation_source_keyword ) {
4989
			$args['_ak'] = urlencode( $activation_source_keyword );
4990
		}
4991
	}
4992
4993
	function build_reconnect_url( $raw = false ) {
4994
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4995
		return $raw ? $url : esc_url( $url );
4996
	}
4997
4998
	public static function admin_url( $args = null ) {
4999
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
0 ignored issues
show
array('page' => 'jetpack') is of type array<string,string,{"page":"string"}>, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
5000
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
5001
		return $url;
5002
	}
5003
5004
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
5005
		$actionurl = str_replace( '&amp;', '&', $actionurl );
5006
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
5007
	}
5008
5009
	function dismiss_jetpack_notice() {
5010
5011
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
5012
			return;
5013
		}
5014
5015
		switch ( $_GET['jetpack-notice'] ) {
5016
			case 'dismiss':
5017
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
5018
5019
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
5020
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
5021
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
5022
				}
5023
				break;
5024
		}
5025
	}
5026
5027
	public static function sort_modules( $a, $b ) {
5028
		if ( $a['sort'] == $b['sort'] ) {
5029
			return 0;
5030
		}
5031
5032
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
5033
	}
5034
5035
	function ajax_recheck_ssl() {
5036
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5037
		$result = self::permit_ssl( true );
5038
		wp_send_json(
5039
			array(
5040
				'enabled' => $result,
5041
				'message' => get_transient( 'jetpack_https_test_message' ),
5042
			)
5043
		);
5044
	}
5045
5046
	/* Client API */
5047
5048
	/**
5049
	 * Returns the requested Jetpack API URL
5050
	 *
5051
	 * @deprecated since 7.7
5052
	 * @return string
5053
	 */
5054
	public static function api_url( $relative_url ) {
5055
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5056
		$connection = self::connection();
5057
		return $connection->api_url( $relative_url );
5058
	}
5059
5060
	/**
5061
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
5062
	 *
5063
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
5064
	 */
5065
	public static function fix_url_for_bad_hosts( $url ) {
5066
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
5067
		return Connection_Utils::fix_url_for_bad_hosts( $url );
5068
	}
5069
5070
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5071
		// Default to a blog token.
5072
		$token_type = 'blog';
5073
5074
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5075
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5076
			if ( ! empty( $_GET['onboarding'] ) ) {
5077
				$jpo = $_GET;
5078
			} else {
5079
				$jpo = json_decode( $request_data, true );
5080
			}
5081
5082
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5083
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5084
5085
			if (
5086
				isset( $jpo_user )
5087
				&& isset( $jpo_token )
5088
				&& is_email( $jpo_user )
5089
				&& ctype_alnum( $jpo_token )
5090
				&& isset( $_GET['rest_route'] )
5091
				&& self::validate_onboarding_token_action(
5092
					$jpo_token,
5093
					$_GET['rest_route']
5094
				)
5095
			) {
5096
				$jp_user = get_user_by( 'email', $jpo_user );
5097
				if ( is_a( $jp_user, 'WP_User' ) ) {
5098
					wp_set_current_user( $jp_user->ID );
5099
					$user_can = is_multisite()
5100
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5101
						: current_user_can( 'manage_options' );
5102
					if ( $user_can ) {
5103
						$token_type              = 'user';
5104
						$token->external_user_id = $jp_user->ID;
5105
					}
5106
				}
5107
			}
5108
5109
			$token_data['type']    = $token_type;
5110
			$token_data['user_id'] = $token->external_user_id;
5111
		}
5112
5113
		return $token_data;
5114
	}
5115
5116
	/**
5117
	 * Create a random secret for validating onboarding payload
5118
	 *
5119
	 * @return string Secret token
5120
	 */
5121
	public static function create_onboarding_token() {
5122
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5123
			$token = wp_generate_password( 32, false );
5124
			Jetpack_Options::update_option( 'onboarding', $token );
5125
		}
5126
5127
		return $token;
5128
	}
5129
5130
	/**
5131
	 * Remove the onboarding token
5132
	 *
5133
	 * @return bool True on success, false on failure
5134
	 */
5135
	public static function invalidate_onboarding_token() {
5136
		return Jetpack_Options::delete_option( 'onboarding' );
5137
	}
5138
5139
	/**
5140
	 * Validate an onboarding token for a specific action
5141
	 *
5142
	 * @return boolean True if token/action pair is accepted, false if not
5143
	 */
5144
	public static function validate_onboarding_token_action( $token, $action ) {
5145
		// Compare tokens, bail if tokens do not match
5146
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5147
			return false;
5148
		}
5149
5150
		// List of valid actions we can take
5151
		$valid_actions = array(
5152
			'/jetpack/v4/settings',
5153
		);
5154
5155
		// Only allow valid actions.
5156
		if ( ! in_array( $action, $valid_actions ) ) {
5157
			return false;
5158
		}
5159
5160
		return true;
5161
	}
5162
5163
	/**
5164
	 * Checks to see if the URL is using SSL to connect with Jetpack
5165
	 *
5166
	 * @since 2.3.3
5167
	 * @return boolean
5168
	 */
5169
	public static function permit_ssl( $force_recheck = false ) {
5170
		// Do some fancy tests to see if ssl is being supported
5171
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5172
			$message = '';
5173
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5174
				$ssl = 0;
5175
			} else {
5176
				switch ( JETPACK_CLIENT__HTTPS ) {
5177
					case 'NEVER':
5178
						$ssl     = 0;
5179
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5180
						break;
5181
					case 'ALWAYS':
5182
					case 'AUTO':
5183
					default:
5184
						$ssl = 1;
5185
						break;
5186
				}
5187
5188
				// If it's not 'NEVER', test to see
5189
				if ( $ssl ) {
5190
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5191
						$ssl     = 0;
5192
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5193
					} else {
5194
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5195
						if ( is_wp_error( $response ) ) {
5196
							$ssl     = 0;
5197
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5198
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5199
							$ssl     = 0;
5200
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5201
						}
5202
					}
5203
				}
5204
			}
5205
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5206
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5207
		}
5208
5209
		return (bool) $ssl;
5210
	}
5211
5212
	/*
5213
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5214
	 */
5215
	public function alert_auto_ssl_fail() {
5216
		if ( ! current_user_can( 'manage_options' ) ) {
5217
			return;
5218
		}
5219
5220
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5221
		?>
5222
5223
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5224
			<div class="jp-banner__content">
5225
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5226
				<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>
5227
				<p>
5228
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5229
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5230
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5231
				</p>
5232
				<p>
5233
					<?php
5234
					printf(
5235
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5236
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5237
						esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5238
					);
5239
					?>
5240
				</p>
5241
			</div>
5242
		</div>
5243
		<style>
5244
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5245
		</style>
5246
		<script type="text/javascript">
5247
			jQuery( document ).ready( function( $ ) {
5248
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5249
					var $this = $( this );
5250
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5251
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5252
					e.preventDefault();
5253
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5254
					$.post( ajaxurl, data )
5255
					  .done( function( response ) {
5256
						  if ( response.enabled ) {
5257
							  $( '#jetpack-ssl-warning' ).hide();
5258
						  } else {
5259
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5260
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5261
						  }
5262
					  }.bind( $this ) );
5263
				} );
5264
			} );
5265
		</script>
5266
5267
		<?php
5268
	}
5269
5270
	/**
5271
	 * Returns the Jetpack XML-RPC API
5272
	 *
5273
	 * @deprecated 8.0 Use Connection_Manager instead.
5274
	 * @return string
5275
	 */
5276
	public static function xmlrpc_api_url() {
5277
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5278
		return self::connection()->xmlrpc_api_url();
5279
	}
5280
5281
	/**
5282
	 * Returns the connection manager object.
5283
	 *
5284
	 * @return Automattic\Jetpack\Connection\Manager
5285
	 */
5286
	public static function connection() {
5287
		$jetpack = static::init();
5288
5289
		// If the connection manager hasn't been instantiated, do that now.
5290
		if ( ! $jetpack->connection_manager ) {
5291
			$jetpack->connection_manager = new Connection_Manager( 'jetpack' );
5292
		}
5293
5294
		return $jetpack->connection_manager;
5295
	}
5296
5297
	/**
5298
	 * Creates two secret tokens and the end of life timestamp for them.
5299
	 *
5300
	 * Note these tokens are unique per call, NOT static per site for connecting.
5301
	 *
5302
	 * @since 2.6
5303
	 * @param String  $action  The action name.
5304
	 * @param Integer $user_id The user identifier.
0 ignored issues
show
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...
5305
	 * @param Integer $exp     Expiration time in seconds.
5306
	 * @return array
5307
	 */
5308
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5309
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5310
	}
5311
5312
	public static function get_secrets( $action, $user_id ) {
5313
		$secrets = self::connection()->get_secrets( $action, $user_id );
5314
5315
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5316
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
0 ignored issues
show
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...
5317
		}
5318
5319
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5320
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
0 ignored issues
show
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...
5321
		}
5322
5323
		return $secrets;
5324
	}
5325
5326
	/**
5327
	 * @deprecated 7.5 Use Connection_Manager instead.
5328
	 *
5329
	 * @param $action
5330
	 * @param $user_id
5331
	 */
5332
	public static function delete_secrets( $action, $user_id ) {
5333
		return self::connection()->delete_secrets( $action, $user_id );
5334
	}
5335
5336
	/**
5337
	 * Builds the timeout limit for queries talking with the wpcom servers.
5338
	 *
5339
	 * Based on local php max_execution_time in php.ini
5340
	 *
5341
	 * @since 2.6
5342
	 * @return int
5343
	 * @deprecated
5344
	 **/
5345
	public function get_remote_query_timeout_limit() {
5346
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5347
		return self::get_max_execution_time();
5348
	}
5349
5350
	/**
5351
	 * Builds the timeout limit for queries talking with the wpcom servers.
5352
	 *
5353
	 * Based on local php max_execution_time in php.ini
5354
	 *
5355
	 * @since 5.4
5356
	 * @return int
5357
	 **/
5358
	public static function get_max_execution_time() {
5359
		$timeout = (int) ini_get( 'max_execution_time' );
5360
5361
		// Ensure exec time set in php.ini
5362
		if ( ! $timeout ) {
5363
			$timeout = 30;
5364
		}
5365
		return $timeout;
5366
	}
5367
5368
	/**
5369
	 * Sets a minimum request timeout, and returns the current timeout
5370
	 *
5371
	 * @since 5.4
5372
	 **/
5373 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5374
		$timeout = self::get_max_execution_time();
5375
		if ( $timeout < $min_timeout ) {
5376
			$timeout = $min_timeout;
5377
			set_time_limit( $timeout );
5378
		}
5379
		return $timeout;
5380
	}
5381
5382
	/**
5383
	 * Takes the response from the Jetpack register new site endpoint and
5384
	 * verifies it worked properly.
5385
	 *
5386
	 * @since 2.6
5387
	 * @deprecated since 7.7.0
5388
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5389
	 **/
5390
	public function validate_remote_register_response() {
5391
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5392
	}
5393
5394
	/**
5395
	 * @return bool|WP_Error
5396
	 */
5397
	public static function register() {
5398
		$tracking = new Tracking();
5399
		$tracking->record_user_event( 'jpc_register_begin' );
5400
5401
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5402
5403
		$connection   = self::connection();
5404
		$registration = $connection->register();
5405
5406
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5407
5408
		if ( ! $registration || is_wp_error( $registration ) ) {
5409
			return $registration;
5410
		}
5411
5412
		return true;
5413
	}
5414
5415
	/**
5416
	 * Filters the registration request body to include tracking properties.
5417
	 *
5418
	 * @param array $properties
5419
	 * @return array amended properties.
5420
	 */
5421 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5422
		$tracking        = new Tracking();
5423
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5424
5425
		return array_merge(
5426
			$properties,
5427
			array(
5428
				'_ui' => $tracks_identity['_ui'],
5429
				'_ut' => $tracks_identity['_ut'],
5430
			)
5431
		);
5432
	}
5433
5434
	/**
5435
	 * Filters the token request body to include tracking properties.
5436
	 *
5437
	 * @param array $properties
5438
	 * @return array amended properties.
5439
	 */
5440 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5441
		$tracking        = new Tracking();
5442
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5443
5444
		return array_merge(
5445
			$properties,
5446
			array(
5447
				'_ui' => $tracks_identity['_ui'],
5448
				'_ut' => $tracks_identity['_ut'],
5449
			)
5450
		);
5451
	}
5452
5453
	/**
5454
	 * If the db version is showing something other that what we've got now, bump it to current.
5455
	 *
5456
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
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...
5457
	 */
5458
	public static function maybe_set_version_option() {
5459
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5460
		if ( JETPACK__VERSION != $version ) {
5461
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5462
5463
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5464
				/** This action is documented in class.jetpack.php */
5465
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5466
			}
5467
5468
			return true;
5469
		}
5470
		return false;
5471
	}
5472
5473
	/* Client Server API */
5474
5475
	/**
5476
	 * Loads the Jetpack XML-RPC client.
5477
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5478
	 *
5479
	 * @deprecated since 7.7.0
5480
	 */
5481
	public static function load_xml_rpc_client() {
5482
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5483
	}
5484
5485
	/**
5486
	 * Resets the saved authentication state in between testing requests.
5487
	 *
5488
	 * @deprecated since 8.9.0
5489
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::reset_saved_auth_state()
5490
	 */
5491
	public function reset_saved_auth_state() {
5492
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::reset_saved_auth_state' );
5493
		Connection_Rest_Authentication::init()->reset_saved_auth_state();
5494
	}
5495
5496
	/**
5497
	 * Verifies the signature of the current request.
5498
	 *
5499
	 * @deprecated since 7.7.0
5500
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5501
	 *
5502
	 * @return false|array
5503
	 */
5504
	public function verify_xml_rpc_signature() {
5505
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5506
		return self::connection()->verify_xml_rpc_signature();
5507
	}
5508
5509
	/**
5510
	 * Verifies the signature of the current request.
5511
	 *
5512
	 * This function has side effects and should not be used. Instead,
5513
	 * use the memoized version `->verify_xml_rpc_signature()`.
5514
	 *
5515
	 * @deprecated since 7.7.0
5516
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5517
	 * @internal
5518
	 */
5519
	private function internal_verify_xml_rpc_signature() {
5520
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5521
	}
5522
5523
	/**
5524
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5525
	 *
5526
	 * @deprecated since 7.7.0
5527
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5528
	 *
5529
	 * @param \WP_User|mixed $user     User object if authenticated.
5530
	 * @param string         $username Username.
5531
	 * @param string         $password Password string.
5532
	 * @return \WP_User|mixed Authenticated user or error.
5533
	 */
5534 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5535
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5536
5537
		if ( ! $this->connection_manager ) {
5538
			$this->connection_manager = new Connection_Manager();
5539
		}
5540
5541
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5542
	}
5543
5544
	/**
5545
	 * Authenticates requests from Jetpack server to WP REST API endpoints.
5546
	 * Uses the existing XMLRPC request signing implementation.
5547
	 *
5548
	 * @deprecated since 8.9.0
5549
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authenticate()
5550
	 */
5551
	function wp_rest_authenticate( $user ) {
5552
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::wp_rest_authenticate' );
5553
		return Connection_Rest_Authentication::init()->wp_rest_authenticate( $user );
5554
	}
5555
5556
	/**
5557
	 * Report authentication status to the WP REST API.
5558
	 *
5559
	 * @deprecated since 8.9.0
5560
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
5561
	 *
5562
	 * @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
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...
5563
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5564
	 */
5565
	public function wp_rest_authentication_errors( $value ) {
5566
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::wp_rest_authenication_errors' );
5567
		return Connection_Rest_Authentication::init()->wp_rest_authentication_errors( $value );
5568
	}
5569
5570
	/**
5571
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5572
	 * Capture it here so we can verify the signature later.
5573
	 *
5574
	 * @deprecated since 7.7.0
5575
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5576
	 *
5577
	 * @param array $methods XMLRPC methods.
5578
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5579
	 */
5580 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5581
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5582
5583
		if ( ! $this->connection_manager ) {
5584
			$this->connection_manager = new Connection_Manager();
5585
		}
5586
5587
		return $this->connection_manager->xmlrpc_methods( $methods );
5588
	}
5589
5590
	/**
5591
	 * Register additional public XMLRPC methods.
5592
	 *
5593
	 * @deprecated since 7.7.0
5594
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5595
	 *
5596
	 * @param array $methods Public XMLRPC methods.
5597
	 * @return array Public XMLRPC methods, with the getOptions one.
5598
	 */
5599 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5600
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5601
5602
		if ( ! $this->connection_manager ) {
5603
			$this->connection_manager = new Connection_Manager();
5604
		}
5605
5606
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5607
	}
5608
5609
	/**
5610
	 * Handles a getOptions XMLRPC method call.
5611
	 *
5612
	 * @deprecated since 7.7.0
5613
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5614
	 *
5615
	 * @param array $args method call arguments.
5616
	 * @return array an amended XMLRPC server options array.
5617
	 */
5618 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5619
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5620
5621
		if ( ! $this->connection_manager ) {
5622
			$this->connection_manager = new Connection_Manager();
5623
		}
5624
5625
		return $this->connection_manager->jetpack_getOptions( $args );
0 ignored issues
show
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...
5626
	}
5627
5628
	/**
5629
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5630
	 *
5631
	 * @deprecated since 7.7.0
5632
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5633
	 *
5634
	 * @param array $options Standard Core options.
5635
	 * @return array Amended options.
5636
	 */
5637 View Code Duplication
	public function xmlrpc_options( $options ) {
5638
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5639
5640
		if ( ! $this->connection_manager ) {
5641
			$this->connection_manager = new Connection_Manager();
5642
		}
5643
5644
		return $this->connection_manager->xmlrpc_options( $options );
5645
	}
5646
5647
	/**
5648
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5649
	 * SET: state( $key, $value );
5650
	 * GET: $value = state( $key );
5651
	 *
5652
	 * @param string $key
0 ignored issues
show
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...
5653
	 * @param string $value
0 ignored issues
show
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...
5654
	 * @param bool   $restate private
5655
	 */
5656
	public static function state( $key = null, $value = null, $restate = false ) {
5657
		static $state = array();
5658
		static $path, $domain;
5659
		if ( ! isset( $path ) ) {
5660
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5661
			$admin_url = self::admin_url();
5662
			$bits      = wp_parse_url( $admin_url );
5663
5664
			if ( is_array( $bits ) ) {
5665
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5666
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5667
			} else {
5668
				$path = $domain = null;
5669
			}
5670
		}
5671
5672
		// Extract state from cookies and delete cookies
5673
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5674
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5675
			unset( $_COOKIE['jetpackState'] );
5676
			foreach ( $yum as $k => $v ) {
0 ignored issues
show
The expression $yum of type string|array<integer,string> is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
5677
				if ( strlen( $v ) ) {
5678
					$state[ $k ] = $v;
5679
				}
5680
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5681
			}
5682
		}
5683
5684
		if ( $restate ) {
5685
			foreach ( $state as $k => $v ) {
5686
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5687
			}
5688
			return;
5689
		}
5690
5691
		// Get a state variable.
5692
		if ( isset( $key ) && ! isset( $value ) ) {
5693
			if ( array_key_exists( $key, $state ) ) {
5694
				return $state[ $key ];
5695
			}
5696
			return null;
5697
		}
5698
5699
		// Set a state variable.
5700
		if ( isset( $key ) && isset( $value ) ) {
5701
			if ( is_array( $value ) && isset( $value[0] ) ) {
5702
				$value = $value[0];
5703
			}
5704
			$state[ $key ] = $value;
5705
			if ( ! headers_sent() ) {
5706
				if ( self::should_set_cookie( $key ) ) {
5707
					setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5708
				}
5709
			}
5710
		}
5711
	}
5712
5713
	public static function restate() {
5714
		self::state( null, null, true );
5715
	}
5716
5717
	/**
5718
	 * Determines whether the jetpackState[$key] value should be added to the
5719
	 * cookie.
5720
	 *
5721
	 * @param string $key The state key.
5722
	 *
5723
	 * @return boolean Whether the value should be added to the cookie.
5724
	 */
5725
	public static function should_set_cookie( $key ) {
5726
		global $current_screen;
5727
		$page = isset( $current_screen->base ) ? $current_screen->base : null;
5728
5729
		if ( 'toplevel_page_jetpack' === $page && 'display_update_modal' === $key ) {
5730
			return false;
5731
		}
5732
5733
		return true;
5734
	}
5735
5736
	public static function check_privacy( $file ) {
5737
		static $is_site_publicly_accessible = null;
5738
5739
		if ( is_null( $is_site_publicly_accessible ) ) {
5740
			$is_site_publicly_accessible = false;
5741
5742
			$rpc = new Jetpack_IXR_Client();
5743
5744
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5745
			if ( $success ) {
5746
				$response = $rpc->getResponse();
5747
				if ( $response ) {
5748
					$is_site_publicly_accessible = true;
5749
				}
5750
			}
5751
5752
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5753
		}
5754
5755
		if ( $is_site_publicly_accessible ) {
5756
			return;
5757
		}
5758
5759
		$module_slug = self::get_module_slug( $file );
5760
5761
		$privacy_checks = self::state( 'privacy_checks' );
5762
		if ( ! $privacy_checks ) {
5763
			$privacy_checks = $module_slug;
5764
		} else {
5765
			$privacy_checks .= ",$module_slug";
5766
		}
5767
5768
		self::state( 'privacy_checks', $privacy_checks );
5769
	}
5770
5771
	/**
5772
	 * Helper method for multicall XMLRPC.
5773
	 *
5774
	 * @deprecated since 8.9.0
5775
	 * @see Automattic\\Jetpack\\Connection\\Xmlrpc_Async_Call::add_call()
5776
	 *
5777
	 * @param ...$args Args for the async_call.
5778
	 */
5779
	public static function xmlrpc_async_call( ...$args ) {
5780
5781
		_deprecated_function( 'Jetpack::xmlrpc_async_call', 'jetpack-8.9.0', 'Automattic\\Jetpack\\Connection\\Xmlrpc_Async_Call::add_call' );
5782
5783
		global $blog_id;
5784
		static $clients = array();
5785
5786
		$client_blog_id = is_multisite() ? $blog_id : 0;
5787
5788
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5789
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => Connection_Manager::CONNECTION_OWNER ) );
5790
			if ( function_exists( 'ignore_user_abort' ) ) {
5791
				ignore_user_abort( true );
5792
			}
5793
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5794
		}
5795
5796
		if ( ! empty( $args[0] ) ) {
5797
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5798
		} elseif ( is_multisite() ) {
5799
			foreach ( $clients as $client_blog_id => $client ) {
5800
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5801
					continue;
5802
				}
5803
5804
				$switch_success = switch_to_blog( $client_blog_id, true );
5805
				if ( ! $switch_success ) {
5806
					continue;
5807
				}
5808
5809
				flush();
5810
				$client->query();
5811
5812
				restore_current_blog();
5813
			}
5814
		} else {
5815
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5816
				flush();
5817
				$clients[0]->query();
5818
			}
5819
		}
5820
	}
5821
5822
	public static function staticize_subdomain( $url ) {
5823
5824
		// Extract hostname from URL
5825
		$host = wp_parse_url( $url, PHP_URL_HOST );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_HOST.

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...
5826
5827
		// Explode hostname on '.'
5828
		$exploded_host = explode( '.', $host );
5829
5830
		// Retrieve the name and TLD
5831
		if ( count( $exploded_host ) > 1 ) {
5832
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5833
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5834
			// Rebuild domain excluding subdomains
5835
			$domain = $name . '.' . $tld;
5836
		} else {
5837
			$domain = $host;
5838
		}
5839
		// Array of Automattic domains.
5840
		$domains_allowed = array( 'wordpress.com', 'wp.com' );
5841
5842
		// Return $url if not an Automattic domain.
5843
		if ( ! in_array( $domain, $domains_allowed, true ) ) {
5844
			return $url;
5845
		}
5846
5847
		if ( is_ssl() ) {
5848
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5849
		}
5850
5851
		srand( crc32( basename( $url ) ) );
5852
		$static_counter = rand( 0, 2 );
5853
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5854
5855
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5856
	}
5857
5858
	/* JSON API Authorization */
5859
5860
	/**
5861
	 * Handles the login action for Authorizing the JSON API
5862
	 */
5863
	function login_form_json_api_authorization() {
5864
		$this->verify_json_api_authorization_request();
5865
5866
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5867
5868
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5869
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5870
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5871
	}
5872
5873
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5874
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5875
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5876
			return $url;
5877
		}
5878
5879
		$parsed_url = wp_parse_url( $url );
5880
		$url        = strtok( $url, '?' );
5881
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5882
		if ( ! empty( $parsed_url['query'] ) ) {
5883
			$url .= "&{$parsed_url['query']}";
5884
		}
5885
5886
		return $url;
5887
	}
5888
5889
	// Make sure the POSTed request is handled by the same action
5890
	function preserve_action_in_login_form_for_json_api_authorization() {
5891
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5892
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5893
	}
5894
5895
	// If someone logs in to approve API access, store the Access Code in usermeta
5896
	function store_json_api_authorization_token( $user_login, $user ) {
5897
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5898
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5899
		$token = wp_generate_password( 32, false );
5900
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5901
	}
5902
5903
	// Add public-api.wordpress.com to the safe redirect allowed list - only added when someone allows API access.
5904
	function allow_wpcom_public_api_domain( $domains ) {
5905
		$domains[] = 'public-api.wordpress.com';
5906
		return $domains;
5907
	}
5908
5909
	static function is_redirect_encoded( $redirect_url ) {
5910
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5911
	}
5912
5913
	// Add all wordpress.com environments to the safe redirect allowed list.
5914
	function allow_wpcom_environments( $domains ) {
5915
		$domains[] = 'wordpress.com';
5916
		$domains[] = 'wpcalypso.wordpress.com';
5917
		$domains[] = 'horizon.wordpress.com';
5918
		$domains[] = 'calypso.localhost';
5919
		return $domains;
5920
	}
5921
5922
	// Add the Access Code details to the public-api.wordpress.com redirect
5923
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5924
		return add_query_arg(
5925
			urlencode_deep(
5926
				array(
5927
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5928
					'jetpack-user-id' => (int) $user->ID,
5929
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5930
				)
5931
			),
5932
			$redirect_to
5933
		);
5934
	}
5935
5936
5937
	/**
5938
	 * Verifies the request by checking the signature
5939
	 *
5940
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5941
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5942
	 *
5943
	 * @param null|array $environment
5944
	 */
5945
	function verify_json_api_authorization_request( $environment = null ) {
5946
		$environment = is_null( $environment )
5947
			? $_REQUEST
5948
			: $environment;
5949
5950
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
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...
5951
		$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...
5952
		if ( ! $token || empty( $token->secret ) ) {
5953
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5954
		}
5955
5956
		$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' );
5957
5958
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5959
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5960
			/**
5961
			 * Jetpack authorisation request Error.
5962
			 *
5963
			 * @since 7.5.0
5964
			 */
5965
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5966
			$die_error = sprintf(
5967
				/* translators: %s is a URL */
5968
				__( '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' ),
5969
				Redirect::get_url( 'jetpack-support-double-encoding' )
5970
			);
5971
		}
5972
5973
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5974
5975
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5976
			$signature = $jetpack_signature->sign_request(
5977
				$environment['token'],
5978
				$environment['timestamp'],
5979
				$environment['nonce'],
5980
				'',
5981
				'GET',
5982
				$environment['jetpack_json_api_original_query'],
5983
				null,
5984
				true
5985
			);
5986
		} else {
5987
			$signature = $jetpack_signature->sign_current_request(
5988
				array(
5989
					'body'   => null,
5990
					'method' => 'GET',
5991
				)
5992
			);
5993
		}
5994
5995
		if ( ! $signature ) {
5996
			wp_die( $die_error );
5997
		} elseif ( is_wp_error( $signature ) ) {
5998
			wp_die( $die_error );
5999
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
6000
			if ( is_ssl() ) {
6001
				// 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
6002
				$signature = $jetpack_signature->sign_current_request(
6003
					array(
6004
						'scheme' => 'http',
6005
						'body'   => null,
6006
						'method' => 'GET',
6007
					)
6008
				);
6009
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6010
					wp_die( $die_error );
6011
				}
6012
			} else {
6013
				wp_die( $die_error );
6014
			}
6015
		}
6016
6017
		$timestamp = (int) $environment['timestamp'];
6018
		$nonce     = stripslashes( (string) $environment['nonce'] );
6019
6020
		if ( ! $this->connection_manager ) {
6021
			$this->connection_manager = new Connection_Manager();
6022
		}
6023
6024
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
6025
			// De-nonce the nonce, at least for 5 minutes.
6026
			// 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)
6027
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6028
			if ( $old_nonce_time < time() - 300 ) {
6029
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6030
			}
6031
		}
6032
6033
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6034
		$data_filters = array(
6035
			'state'        => 'opaque',
6036
			'client_id'    => 'int',
6037
			'client_title' => 'string',
6038
			'client_image' => 'url',
6039
		);
6040
6041
		foreach ( $data_filters as $key => $sanitation ) {
6042
			if ( ! isset( $data->$key ) ) {
6043
				wp_die( $die_error );
6044
			}
6045
6046
			switch ( $sanitation ) {
6047
				case 'int':
6048
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6049
					break;
6050
				case 'opaque':
6051
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6052
					break;
6053
				case 'string':
6054
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6055
					break;
6056
				case 'url':
6057
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6058
					break;
6059
			}
6060
		}
6061
6062
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6063
			wp_die( $die_error );
6064
		}
6065
	}
6066
6067
	function login_message_json_api_authorization( $message ) {
6068
		return '<p class="message">' . sprintf(
6069
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6070
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6071
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6072
	}
6073
6074
	/**
6075
	 * Get $content_width, but with a <s>twist</s> filter.
6076
	 */
6077
	public static function get_content_width() {
6078
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6079
			? $GLOBALS['content_width']
6080
			: false;
6081
		/**
6082
		 * Filter the Content Width value.
6083
		 *
6084
		 * @since 2.2.3
6085
		 *
6086
		 * @param string $content_width Content Width value.
6087
		 */
6088
		return apply_filters( 'jetpack_content_width', $content_width );
6089
	}
6090
6091
	/**
6092
	 * Pings the WordPress.com Mirror Site for the specified options.
6093
	 *
6094
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6095
	 *
6096
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6097
	 */
6098
	public function get_cloud_site_options( $option_names ) {
6099
		$option_names = array_filter( (array) $option_names, 'is_string' );
6100
6101
		$xml = new Jetpack_IXR_Client();
6102
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6103
		if ( $xml->isError() ) {
6104
			return array(
6105
				'error_code' => $xml->getErrorCode(),
6106
				'error_msg'  => $xml->getErrorMessage(),
6107
			);
6108
		}
6109
		$cloud_site_options = $xml->getResponse();
6110
6111
		return $cloud_site_options;
6112
	}
6113
6114
	/**
6115
	 * Checks if the site is currently in an identity crisis.
6116
	 *
6117
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6118
	 */
6119
	public static function check_identity_crisis() {
6120
		if ( ! self::is_active() || ( new Status() )->is_offline_mode() || ! self::validate_sync_error_idc_option() ) {
6121
			return false;
6122
		}
6123
6124
		return Jetpack_Options::get_option( 'sync_error_idc' );
6125
	}
6126
6127
	/**
6128
	 * Checks whether the home and siteurl specifically are allowed.
6129
	 * Written so that we don't have re-check $key and $value params every time
6130
	 * we want to check if this site is allowed, for example in footer.php
6131
	 *
6132
	 * @since  3.8.0
6133
	 * @return bool True = already allowed False = not on the allowed list.
6134
	 */
6135
	public static function is_staging_site() {
6136
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6137
		return ( new Status() )->is_staging_site();
6138
	}
6139
6140
	/**
6141
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6142
	 *
6143
	 * @since 4.4.0
6144
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6145
	 *
6146
	 * @return bool
6147
	 */
6148
	public static function validate_sync_error_idc_option() {
6149
		$is_valid = false;
6150
6151
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6152
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6153
		if ( $sync_error && self::sync_idc_optin() ) {
6154
			$local_options = self::get_sync_error_idc_option();
6155
			// Ensure all values are set.
6156
			if ( isset( $sync_error['home'] ) && isset( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6157
6158
				// If the WP.com expected home and siteurl match local home and siteurl it is not valid IDC.
6159
				if (
6160
						isset( $sync_error['wpcom_home'] ) &&
6161
						isset( $sync_error['wpcom_siteurl'] ) &&
6162
						$sync_error['wpcom_home'] === $local_options['home'] &&
6163
						$sync_error['wpcom_siteurl'] === $local_options['siteurl']
6164
				) {
6165
					$is_valid = false;
6166
					// Enable migrate_for_idc so that sync actions are accepted.
6167
					Jetpack_Options::update_option( 'migrate_for_idc', true );
6168
				} elseif ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6169
					$is_valid = true;
6170
				}
6171
			}
6172
		}
6173
6174
		/**
6175
		 * Filters whether the sync_error_idc option is valid.
6176
		 *
6177
		 * @since 4.4.0
6178
		 *
6179
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6180
		 */
6181
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6182
6183
		if ( ! $is_valid && $sync_error ) {
6184
			// Since the option exists, and did not validate, delete it
6185
			Jetpack_Options::delete_option( 'sync_error_idc' );
6186
		}
6187
6188
		return $is_valid;
6189
	}
6190
6191
	/**
6192
	 * Normalizes a url by doing three things:
6193
	 *  - Strips protocol
6194
	 *  - Strips www
6195
	 *  - Adds a trailing slash
6196
	 *
6197
	 * @since 4.4.0
6198
	 * @param string $url
6199
	 * @return WP_Error|string
6200
	 */
6201
	public static function normalize_url_protocol_agnostic( $url ) {
6202
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6203 View Code Duplication
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6204
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
0 ignored issues
show
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...
6205
		}
6206
6207
		// Strip www and protocols
6208
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6209
		return $url;
6210
	}
6211
6212
	/**
6213
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6214
	 *
6215
	 * @since 4.4.0
6216
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6217
	 *
6218
	 * @param array $response
6219
	 * @return array Array of the local urls, wpcom urls, and error code
6220
	 */
6221
	public static function get_sync_error_idc_option( $response = array() ) {
6222
		// Since the local options will hit the database directly, store the values
6223
		// in a transient to allow for autoloading and caching on subsequent views.
6224
		$local_options = get_transient( 'jetpack_idc_local' );
6225
		if ( false === $local_options ) {
6226
			$local_options = array(
6227
				'home'    => Functions::home_url(),
6228
				'siteurl' => Functions::site_url(),
6229
			);
6230
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6231
		}
6232
6233
		$options = array_merge( $local_options, $response );
6234
6235
		$returned_values = array();
6236
		foreach ( $options as $key => $option ) {
6237
			if ( 'error_code' === $key ) {
6238
				$returned_values[ $key ] = $option;
6239
				continue;
6240
			}
6241
6242
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6243
				continue;
6244
			}
6245
6246
			$returned_values[ $key ] = $normalized_url;
6247
		}
6248
6249
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6250
6251
		return $returned_values;
6252
	}
6253
6254
	/**
6255
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6256
	 * If set to true, the site will be put into staging mode.
6257
	 *
6258
	 * @since 4.3.2
6259
	 * @return bool
6260
	 */
6261
	public static function sync_idc_optin() {
6262
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6263
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6264
		} else {
6265
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6266
		}
6267
6268
		/**
6269
		 * Allows sites to opt in for IDC mitigation which blocks the site from syncing to WordPress.com when the home
6270
		 * URL or site URL do not match what WordPress.com expects. The default value is either true, or the value of
6271
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6272
		 *
6273
		 * @since 4.3.2
6274
		 *
6275
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6276
		 */
6277
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6278
	}
6279
6280
	/**
6281
	 * Maybe Use a .min.css stylesheet, maybe not.
6282
	 *
6283
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6284
	 */
6285
	public static function maybe_min_asset( $url, $path, $plugin ) {
6286
		// Short out on things trying to find actual paths.
6287
		if ( ! $path || empty( $plugin ) ) {
6288
			return $url;
6289
		}
6290
6291
		$path = ltrim( $path, '/' );
6292
6293
		// Strip out the abspath.
6294
		$base = dirname( plugin_basename( $plugin ) );
6295
6296
		// Short out on non-Jetpack assets.
6297
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6298
			return $url;
6299
		}
6300
6301
		// File name parsing.
6302
		$file              = "{$base}/{$path}";
6303
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6304
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6305
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6306
		$extension         = array_shift( $file_name_parts_r );
6307
6308
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6309
			// Already pointing at the minified version.
6310
			if ( 'min' === $file_name_parts_r[0] ) {
6311
				return $url;
6312
			}
6313
6314
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6315
			if ( file_exists( $min_full_path ) ) {
6316
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6317
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6318
				if ( 'css' === $extension ) {
6319
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6320
					self::$min_assets[ $key ] = $path;
6321
				}
6322
			}
6323
		}
6324
6325
		return $url;
6326
	}
6327
6328
	/**
6329
	 * If the asset is minified, let's flag .min as the suffix.
6330
	 *
6331
	 * Attached to `style_loader_src` filter.
6332
	 *
6333
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
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...
6334
	 * @param string $handle The registered handle of the script in question.
6335
	 * @param string $href The url of the asset in question.
0 ignored issues
show
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...
6336
	 */
6337
	public static function set_suffix_on_min( $src, $handle ) {
6338
		if ( false === strpos( $src, '.min.css' ) ) {
6339
			return $src;
6340
		}
6341
6342
		if ( ! empty( self::$min_assets ) ) {
6343
			foreach ( self::$min_assets as $file => $path ) {
6344
				if ( false !== strpos( $src, $file ) ) {
6345
					wp_style_add_data( $handle, 'suffix', '.min' );
6346
					return $src;
6347
				}
6348
			}
6349
		}
6350
6351
		return $src;
6352
	}
6353
6354
	/**
6355
	 * Maybe inlines a stylesheet.
6356
	 *
6357
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6358
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6359
	 *
6360
	 * Attached to `style_loader_tag` filter.
6361
	 *
6362
	 * @param string $tag The tag that would link to the external asset.
6363
	 * @param string $handle The registered handle of the script in question.
6364
	 *
6365
	 * @return string
6366
	 */
6367
	public static function maybe_inline_style( $tag, $handle ) {
6368
		global $wp_styles;
6369
		$item = $wp_styles->registered[ $handle ];
6370
6371
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6372
			return $tag;
6373
		}
6374
6375
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6376
			$href = $matches[1];
6377
			// Strip off query string
6378
			if ( $pos = strpos( $href, '?' ) ) {
6379
				$href = substr( $href, 0, $pos );
6380
			}
6381
			// Strip off fragment
6382
			if ( $pos = strpos( $href, '#' ) ) {
6383
				$href = substr( $href, 0, $pos );
6384
			}
6385
		} else {
6386
			return $tag;
6387
		}
6388
6389
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6390
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6391
			return $tag;
6392
		}
6393
6394
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6395
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6396
			// And this isn't the pass that actually deals with the RTL version...
6397
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6398
				// Short out, as the RTL version will deal with it in a moment.
6399
				return $tag;
6400
			}
6401
		}
6402
6403
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6404
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6405
		if ( $css ) {
6406
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6407
			if ( empty( $item->extra['after'] ) ) {
6408
				wp_add_inline_style( $handle, $css );
6409
			} else {
6410
				array_unshift( $item->extra['after'], $css );
6411
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6412
			}
6413
		}
6414
6415
		return $tag;
6416
	}
6417
6418
	/**
6419
	 * Loads a view file from the views
6420
	 *
6421
	 * Data passed in with the $data parameter will be available in the
6422
	 * template file as $data['value']
6423
	 *
6424
	 * @param string $template - Template file to load
6425
	 * @param array  $data - Any data to pass along to the template
6426
	 * @return boolean - If template file was found
6427
	 **/
6428
	public function load_view( $template, $data = array() ) {
6429
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6430
6431
		if ( file_exists( $views_dir . $template ) ) {
6432
			require_once $views_dir . $template;
6433
			return true;
6434
		}
6435
6436
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6437
		return false;
6438
	}
6439
6440
	/**
6441
	 * Throws warnings for deprecated hooks to be removed from Jetpack that cannot remain in the original place in the code.
6442
	 *
6443
	 * @todo Convert these to use apply_filters_deprecated and do_action_deprecated and remove custom code.
6444
	 */
6445
	public function deprecated_hooks() {
6446
		global $wp_filter;
6447
6448
		/*
6449
		 * Format:
6450
		 * deprecated_filter_name => replacement_name
6451
		 *
6452
		 * If there is no replacement, use null for replacement_name
6453
		 */
6454
		$deprecated_list = array(
6455
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6456
			'wpl_sharing_2014_1'                           => null,
6457
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6458
			'jetpack_identity_crisis_options_to_check'     => null,
6459
			'update_option_jetpack_single_user_site'       => null,
6460
			'audio_player_default_colors'                  => null,
6461
			'add_option_jetpack_featured_images_enabled'   => null,
6462
			'add_option_jetpack_update_details'            => null,
6463
			'add_option_jetpack_updates'                   => null,
6464
			'add_option_jetpack_network_name'              => null,
6465
			'add_option_jetpack_network_allow_new_registrations' => null,
6466
			'add_option_jetpack_network_add_new_users'     => null,
6467
			'add_option_jetpack_network_site_upload_space' => null,
6468
			'add_option_jetpack_network_upload_file_types' => null,
6469
			'add_option_jetpack_network_enable_administration_menus' => null,
6470
			'add_option_jetpack_is_multi_site'             => null,
6471
			'add_option_jetpack_is_main_network'           => null,
6472
			'add_option_jetpack_main_network_site'         => null,
6473
			'jetpack_sync_all_registered_options'          => null,
6474
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6475
			'jetpack_is_post_mailable'                     => null,
6476
			'jetpack_seo_site_host'                        => null,
6477
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6478
			'jetpack_holiday_snow_option_name'             => null,
6479
			'jetpack_holiday_chance_of_snow'               => null,
6480
			'jetpack_holiday_snow_js_url'                  => null,
6481
			'jetpack_is_holiday_snow_season'               => null,
6482
			'jetpack_holiday_snow_option_updated'          => null,
6483
			'jetpack_holiday_snowing'                      => null,
6484
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6485
			'jetpack_cache_plans'                          => null,
6486
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6487
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6488
			'jetpack_enable_site_verification'             => null,
6489
			// Removed in Jetpack 7.3.0
6490
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6491
			// Removed in Jetpack 7.9.0
6492
			'jetpack_pwa_manifest'                         => null,
6493
			'jetpack_pwa_background_color'                 => null,
6494
			// Removed in Jetpack 8.3.0.
6495
			'jetpack_check_mobile'                         => null,
6496
			'jetpack_mobile_stylesheet'                    => null,
6497
			'jetpack_mobile_template'                      => null,
6498
			'mobile_reject_mobile'                         => null,
6499
			'mobile_force_mobile'                          => null,
6500
			'mobile_app_promo_download'                    => null,
6501
			'mobile_setup'                                 => null,
6502
			'jetpack_mobile_footer_before'                 => null,
6503
			'wp_mobile_theme_footer'                       => null,
6504
			'minileven_credits'                            => null,
6505
			'jetpack_mobile_header_before'                 => null,
6506
			'jetpack_mobile_header_after'                  => null,
6507
			'jetpack_mobile_theme_menu'                    => null,
6508
			'minileven_show_featured_images'               => null,
6509
			'minileven_attachment_size'                    => null,
6510
		);
6511
6512
		// This is a silly loop depth. Better way?
6513
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6514
			if ( has_action( $hook ) ) {
6515
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6516
					foreach ( $values as $hooked ) {
6517
						if ( is_callable( $hooked['function'] ) ) {
6518
							$function_name = $hooked['function'];
6519
						} else {
6520
							$function_name = 'an anonymous function';
6521
						}
6522
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6523
					}
6524
				}
6525
			}
6526
		}
6527
6528
		$filter_deprecated_list = array(
6529
			'can_display_jetpack_manage_notice' => array(
6530
				'replacement' => null,
6531
				'version'     => 'jetpack-7.3.0',
6532
			),
6533
			'atd_http_post_timeout'             => array(
6534
				'replacement' => null,
6535
				'version'     => 'jetpack-7.3.0',
6536
			),
6537
			'atd_service_domain'                => array(
6538
				'replacement' => null,
6539
				'version'     => 'jetpack-7.3.0',
6540
			),
6541
			'atd_load_scripts'                  => array(
6542
				'replacement' => null,
6543
				'version'     => 'jetpack-7.3.0',
6544
			),
6545
		);
6546
6547
		foreach ( $filter_deprecated_list as $tag => $args ) {
6548
			if ( has_filter( $tag ) ) {
6549
				apply_filters_deprecated( $tag, array(), $args['version'], $args['replacement'] );
6550
			}
6551
		}
6552
6553
		$action_deprecated_list = array(
6554
			'atd_http_post_error' => array(
6555
				'replacement' => null,
6556
				'version'     => 'jetpack-7.3.0',
6557
			),
6558
		);
6559
6560
		foreach ( $action_deprecated_list as $tag => $args ) {
6561
			if ( has_action( $tag ) ) {
6562
				do_action_deprecated( $tag, array(), $args['version'], $args['replacement'] );
6563
			}
6564
		}
6565
	}
6566
6567
	/**
6568
	 * Converts any url in a stylesheet, to the correct absolute url.
6569
	 *
6570
	 * Considerations:
6571
	 *  - Normal, relative URLs     `feh.png`
6572
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6573
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6574
	 *  - Absolute URLs             `http://domain.com/feh.png`
6575
	 *  - Domain root relative URLs `/feh.png`
6576
	 *
6577
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6578
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6579
	 *
6580
	 * @return mixed|string
6581
	 */
6582
	public static function absolutize_css_urls( $css, $css_file_url ) {
6583
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6584
		$css_dir = dirname( $css_file_url );
6585
		$p       = wp_parse_url( $css_dir );
6586
		$domain  = sprintf(
6587
			'%1$s//%2$s%3$s%4$s',
6588
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6589
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6590
			$p['host'],
6591
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6592
		);
6593
6594
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6595
			$find = $replace = array();
6596
			foreach ( $matches as $match ) {
6597
				$url = trim( $match['path'], "'\" \t" );
6598
6599
				// If this is a data url, we don't want to mess with it.
6600
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6601
					continue;
6602
				}
6603
6604
				// If this is an absolute or protocol-agnostic url,
6605
				// we don't want to mess with it.
6606
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6607
					continue;
6608
				}
6609
6610
				switch ( substr( $url, 0, 1 ) ) {
6611
					case '/':
6612
						$absolute = $domain . $url;
6613
						break;
6614
					default:
6615
						$absolute = $css_dir . '/' . $url;
6616
				}
6617
6618
				$find[]    = $match[0];
6619
				$replace[] = sprintf( 'url("%s")', $absolute );
6620
			}
6621
			$css = str_replace( $find, $replace, $css );
6622
		}
6623
6624
		return $css;
6625
	}
6626
6627
	/**
6628
	 * This methods removes all of the registered css files on the front end
6629
	 * from Jetpack in favor of using a single file. In effect "imploding"
6630
	 * all the files into one file.
6631
	 *
6632
	 * Pros:
6633
	 * - Uses only ONE css asset connection instead of 15
6634
	 * - Saves a minimum of 56k
6635
	 * - Reduces server load
6636
	 * - Reduces time to first painted byte
6637
	 *
6638
	 * Cons:
6639
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6640
	 *      should not cause any issues with themes.
6641
	 * - Plugins/themes dequeuing styles no longer do anything. See
6642
	 *      jetpack_implode_frontend_css filter for a workaround
6643
	 *
6644
	 * For some situations developers may wish to disable css imploding and
6645
	 * instead operate in legacy mode where each file loads seperately and
6646
	 * can be edited individually or dequeued. This can be accomplished with
6647
	 * the following line:
6648
	 *
6649
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6650
	 *
6651
	 * @since 3.2
6652
	 **/
6653
	public function implode_frontend_css( $travis_test = false ) {
6654
		$do_implode = true;
6655
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6656
			$do_implode = false;
6657
		}
6658
6659
		// Do not implode CSS when the page loads via the AMP plugin.
6660
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6661
			$do_implode = false;
6662
		}
6663
6664
		/**
6665
		 * Allow CSS to be concatenated into a single jetpack.css file.
6666
		 *
6667
		 * @since 3.2.0
6668
		 *
6669
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6670
		 */
6671
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6672
6673
		// Do not use the imploded file when default behavior was altered through the filter
6674
		if ( ! $do_implode ) {
6675
			return;
6676
		}
6677
6678
		// We do not want to use the imploded file in dev mode, or if not connected
6679
		if ( ( new Status() )->is_offline_mode() || ! self::is_active() ) {
6680
			if ( ! $travis_test ) {
6681
				return;
6682
			}
6683
		}
6684
6685
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6686
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6687
			return;
6688
		}
6689
6690
		/*
6691
		 * Now we assume Jetpack is connected and able to serve the single
6692
		 * file.
6693
		 *
6694
		 * In the future there will be a check here to serve the file locally
6695
		 * or potentially from the Jetpack CDN
6696
		 *
6697
		 * For now:
6698
		 * - Enqueue a single imploded css file
6699
		 * - Zero out the style_loader_tag for the bundled ones
6700
		 * - Be happy, drink scotch
6701
		 */
6702
6703
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6704
6705
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6706
6707
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6708
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6709
	}
6710
6711
	function concat_remove_style_loader_tag( $tag, $handle ) {
6712
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6713
			$tag = '';
6714
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6715
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6716
			}
6717
		}
6718
6719
		return $tag;
6720
	}
6721
6722
	/**
6723
	 * @deprecated
6724
	 * @see Automattic\Jetpack\Assets\add_aync_script
6725
	 */
6726
	public function script_add_async( $tag, $handle, $src ) {
6727
		_deprecated_function( __METHOD__, 'jetpack-8.6.0' );
6728
	}
6729
6730
	/*
6731
	 * Check the heartbeat data
6732
	 *
6733
	 * Organizes the heartbeat data by severity.  For example, if the site
6734
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6735
	 *
6736
	 * Data will be added to "caution" array, if it either:
6737
	 *  - Out of date Jetpack version
6738
	 *  - Out of date WP version
6739
	 *  - Out of date PHP version
6740
	 *
6741
	 * $return array $filtered_data
6742
	 */
6743
	public static function jetpack_check_heartbeat_data() {
6744
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6745
6746
		$good    = array();
6747
		$caution = array();
6748
		$bad     = array();
6749
6750
		foreach ( $raw_data as $stat => $value ) {
6751
6752
			// Check jetpack version
6753
			if ( 'version' == $stat ) {
6754
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6755
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6756
					continue;
6757
				}
6758
			}
6759
6760
			// Check WP version
6761
			if ( 'wp-version' == $stat ) {
6762
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6763
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6764
					continue;
6765
				}
6766
			}
6767
6768
			// Check PHP version
6769
			if ( 'php-version' == $stat ) {
6770
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6771
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_PHP_VERSION;
6772
					continue;
6773
				}
6774
			}
6775
6776
			// Check ID crisis
6777
			if ( 'identitycrisis' == $stat ) {
6778
				if ( 'yes' == $value ) {
6779
					$bad[ $stat ] = $value;
6780
					continue;
6781
				}
6782
			}
6783
6784
			// The rest are good :)
6785
			$good[ $stat ] = $value;
6786
		}
6787
6788
		$filtered_data = array(
6789
			'good'    => $good,
6790
			'caution' => $caution,
6791
			'bad'     => $bad,
6792
		);
6793
6794
		return $filtered_data;
6795
	}
6796
6797
6798
	/*
6799
	 * This method is used to organize all options that can be reset
6800
	 * without disconnecting Jetpack.
6801
	 *
6802
	 * It is used in class.jetpack-cli.php to reset options
6803
	 *
6804
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6805
	 *
6806
	 * @return array of options to delete.
6807
	 */
6808
	public static function get_jetpack_options_for_reset() {
6809
		return Jetpack_Options::get_options_for_reset();
6810
	}
6811
6812
	/*
6813
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6814
	 * so we can bring them directly to their site in calypso.
6815
	 *
6816
	 * @param string | url
6817
	 * @return string | url without the guff
6818
	 */
6819 View Code Duplication
	public static function build_raw_urls( $url ) {
6820
		$strip_http = '/.*?:\/\//i';
6821
		$url        = preg_replace( $strip_http, '', $url );
6822
		$url        = str_replace( '/', '::', $url );
6823
		return $url;
6824
	}
6825
6826
	/**
6827
	 * Stores and prints out domains to prefetch for page speed optimization.
6828
	 *
6829
	 * @deprecated 8.8.0 Use Jetpack::add_resource_hints.
6830
	 *
6831
	 * @param string|array $urls URLs to hint.
0 ignored issues
show
Should the type for parameter $urls not be string|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...
6832
	 */
6833
	public static function dns_prefetch( $urls = null ) {
6834
		_deprecated_function( __FUNCTION__, 'jetpack-8.8.0', 'Automattic\Jetpack\Assets::add_resource_hint' );
6835
		if ( $urls ) {
6836
			Assets::add_resource_hint( $urls );
6837
		}
6838
	}
6839
6840
	public function wp_dashboard_setup() {
6841
		if ( self::is_active() ) {
6842
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6843
		}
6844
6845
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6846
			$jetpack_logo = new Jetpack_Logo();
6847
			$widget_title = sprintf(
6848
				wp_kses(
6849
					/* translators: Placeholder is a Jetpack logo. */
6850
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6851
					array( 'span' => array() )
6852
				),
6853
				$jetpack_logo->get_jp_emblem( true )
6854
			);
6855
6856
			wp_add_dashboard_widget(
6857
				'jetpack_summary_widget',
6858
				$widget_title,
6859
				array( __CLASS__, 'dashboard_widget' )
6860
			);
6861
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6862
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6863
6864
			// If we're inactive and not in offline mode, sort our box to the top.
6865
			if ( ! self::is_active() && ! ( new Status() )->is_offline_mode() ) {
6866
				global $wp_meta_boxes;
6867
6868
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6869
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6870
6871
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6872
			}
6873
		}
6874
	}
6875
6876
	/**
6877
	 * @param mixed $result Value for the user's option
0 ignored issues
show
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...
6878
	 * @return mixed
6879
	 */
6880
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6881
		if ( ! is_array( $sorted ) ) {
6882
			return $sorted;
6883
		}
6884
6885
		foreach ( $sorted as $box_context => $ids ) {
6886
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6887
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6888
				continue;
6889
			}
6890
6891
			$ids_array = explode( ',', $ids );
6892
			$key       = array_search( 'dashboard_stats', $ids_array );
6893
6894
			if ( false !== $key ) {
6895
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6896
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6897
				$sorted[ $box_context ] = implode( ',', $ids_array );
6898
				// We've found it, stop searching, and just return.
6899
				break;
6900
			}
6901
		}
6902
6903
		return $sorted;
6904
	}
6905
6906
	public static function dashboard_widget() {
6907
		/**
6908
		 * Fires when the dashboard is loaded.
6909
		 *
6910
		 * @since 3.4.0
6911
		 */
6912
		do_action( 'jetpack_dashboard_widget' );
6913
	}
6914
6915
	public static function dashboard_widget_footer() {
6916
		?>
6917
		<footer>
6918
6919
		<div class="protect">
6920
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
6921
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6922
				<p class="blocked-count">
6923
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
6924
				</p>
6925
				<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>
6926
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_offline_mode() ) : ?>
6927
				<a href="
6928
				<?php
6929
				echo esc_url(
6930
					wp_nonce_url(
6931
						self::admin_url(
6932
							array(
6933
								'action' => 'activate',
6934
								'module' => 'protect',
6935
							)
6936
						),
6937
						'jetpack_activate-protect'
6938
					)
6939
				);
6940
				?>
6941
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6942
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
6943
				</a>
6944
			<?php else : ?>
6945
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
6946
			<?php endif; ?>
6947
		</div>
6948
6949
		<div class="akismet">
6950
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
6951
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6952
				<p class="blocked-count">
6953
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
6954
				</p>
6955
				<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>
6956
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6957
				<a href="
6958
				<?php
6959
				echo esc_url(
6960
					wp_nonce_url(
6961
						add_query_arg(
6962
							array(
6963
								'action' => 'activate',
6964
								'plugin' => 'akismet/akismet.php',
6965
							),
6966
							admin_url( 'plugins.php' )
6967
						),
6968
						'activate-plugin_akismet/akismet.php'
6969
					)
6970
				);
6971
				?>
6972
							" class="button button-jetpack">
6973
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
6974
				</a>
6975
			<?php else : ?>
6976
				<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>
6977
			<?php endif; ?>
6978
		</div>
6979
6980
		</footer>
6981
		<?php
6982
	}
6983
6984
	/*
6985
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6986
	 */
6987
	function jetpack_icon_user_connected( $columns ) {
6988
		$columns['user_jetpack'] = '';
6989
		return $columns;
6990
	}
6991
6992
	/*
6993
	 * Show Jetpack icon if the user is linked.
6994
	 */
6995
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6996
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
6997
			$jetpack_logo = new Jetpack_Logo();
6998
			$emblem_html  = sprintf(
6999
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7000
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7001
				$jetpack_logo->get_jp_emblem()
7002
			);
7003
			return $emblem_html;
7004
		}
7005
7006
		return $val;
7007
	}
7008
7009
	/*
7010
	 * Style the Jetpack user column
7011
	 */
7012
	function jetpack_user_col_style() {
7013
		global $current_screen;
7014
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7015
			?>
7016
			<style>
7017
				.fixed .column-user_jetpack {
7018
					width: 21px;
7019
				}
7020
				.jp-emblem-user-admin svg {
7021
					width: 20px;
7022
					height: 20px;
7023
				}
7024
				.jp-emblem-user-admin path {
7025
					fill: #00BE28;
7026
				}
7027
			</style>
7028
			<?php
7029
		}
7030
	}
7031
7032
	/**
7033
	 * Checks if Akismet is active and working.
7034
	 *
7035
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7036
	 * that implied usage of methods present since more recent version.
7037
	 * See https://github.com/Automattic/jetpack/pull/9585
7038
	 *
7039
	 * @since  5.1.0
7040
	 *
7041
	 * @return bool True = Akismet available. False = Aksimet not available.
7042
	 */
7043
	public static function is_akismet_active() {
7044
		static $status = null;
7045
7046
		if ( ! is_null( $status ) ) {
7047
			return $status;
7048
		}
7049
7050
		// Check if a modern version of Akismet is active.
7051
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7052
			$status = false;
7053
			return $status;
7054
		}
7055
7056
		// Make sure there is a key known to Akismet at all before verifying key.
7057
		$akismet_key = Akismet::get_api_key();
7058
		if ( ! $akismet_key ) {
7059
			$status = false;
7060
			return $status;
7061
		}
7062
7063
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7064
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7065
7066
		// 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.
7067
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7068
		// We cache the result of the Akismet key verification for ten minutes.
7069
		if ( ! $akismet_key_state || $recheck ) {
7070
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7071
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7072
		}
7073
7074
		$status = 'valid' === $akismet_key_state;
7075
7076
		return $status;
7077
	}
7078
7079
	/**
7080
	 * @deprecated
7081
	 *
7082
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7083
	 */
7084
	public static function is_function_in_backtrace() {
7085
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7086
	}
7087
7088
	/**
7089
	 * Given a minified path, and a non-minified path, will return
7090
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7091
	 *
7092
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7093
	 * root Jetpack directory.
7094
	 *
7095
	 * @since 5.6.0
7096
	 *
7097
	 * @param string $min_path
7098
	 * @param string $non_min_path
7099
	 * @return string The URL to the file
7100
	 */
7101
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7102
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7103
	}
7104
7105
	/**
7106
	 * Checks for whether Jetpack Backup is enabled.
7107
	 * Will return true if the state of Backup is anything except "unavailable".
7108
	 *
7109
	 * @return bool|int|mixed
7110
	 */
7111
	public static function is_rewind_enabled() {
7112
		if ( ! self::is_active() ) {
7113
			return false;
7114
		}
7115
7116
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7117
		if ( false === $rewind_enabled ) {
7118
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7119
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7120
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7121
				&& ! empty( $rewind_data['state'] )
7122
				&& 'active' === $rewind_data['state'] )
7123
				? 1
7124
				: 0;
7125
7126
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7127
		}
7128
		return $rewind_enabled;
7129
	}
7130
7131
	/**
7132
	 * Return Calypso environment value; used for developing Jetpack and pairing
7133
	 * it with different Calypso enrionments, such as localhost.
7134
	 *
7135
	 * @since 7.4.0
7136
	 *
7137
	 * @return string Calypso environment
7138
	 */
7139
	public static function get_calypso_env() {
7140
		if ( isset( $_GET['calypso_env'] ) ) {
7141
			return sanitize_key( $_GET['calypso_env'] );
7142
		}
7143
7144
		if ( getenv( 'CALYPSO_ENV' ) ) {
7145
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7146
		}
7147
7148
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7149
			return sanitize_key( CALYPSO_ENV );
7150
		}
7151
7152
		return '';
7153
	}
7154
7155
	/**
7156
	 * Returns the hostname with protocol for Calypso.
7157
	 * Used for developing Jetpack with Calypso.
7158
	 *
7159
	 * @since 8.4.0
7160
	 *
7161
	 * @return string Calypso host.
7162
	 */
7163
	public static function get_calypso_host() {
7164
		$calypso_env = self::get_calypso_env();
7165
		switch ( $calypso_env ) {
7166
			case 'development':
7167
				return 'http://calypso.localhost:3000/';
7168
			case 'wpcalypso':
7169
				return 'https://wpcalypso.wordpress.com/';
7170
			case 'horizon':
7171
				return 'https://horizon.wordpress.com/';
7172
			default:
7173
				return 'https://wordpress.com/';
7174
		}
7175
	}
7176
7177
	/**
7178
	 * Handles activating default modules as well general cleanup for the new connection.
7179
	 *
7180
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7181
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7182
	 * @param boolean $send_state_messages          Whether to send state messages.
7183
	 * @return void
7184
	 */
7185
	public static function handle_post_authorization_actions(
7186
		$activate_sso = false,
7187
		$redirect_on_activation_error = false,
7188
		$send_state_messages = true
7189
	) {
7190
		$other_modules = $activate_sso
7191
			? array( 'sso' )
7192
			: array();
7193
7194
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7195
			self::delete_active_modules();
7196
7197
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
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...
7198
		} else {
7199
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7200
		}
7201
7202
		// Since this is a fresh connection, be sure to clear out IDC options
7203
		Jetpack_IDC::clear_all_idc_options();
7204
7205
		if ( $send_state_messages ) {
7206
			self::state( 'message', 'authorized' );
7207
		}
7208
	}
7209
7210
	/**
7211
	 * Returns a boolean for whether backups UI should be displayed or not.
7212
	 *
7213
	 * @return bool Should backups UI be displayed?
7214
	 */
7215
	public static function show_backups_ui() {
7216
		/**
7217
		 * Whether UI for backups should be displayed.
7218
		 *
7219
		 * @since 6.5.0
7220
		 *
7221
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7222
		 */
7223
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7224
	}
7225
7226
	/*
7227
	 * Deprecated manage functions
7228
	 */
7229
	function prepare_manage_jetpack_notice() {
7230
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7231
	}
7232
	function manage_activate_screen() {
7233
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7234
	}
7235
	function admin_jetpack_manage_notice() {
7236
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7237
	}
7238
	function opt_out_jetpack_manage_url() {
7239
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7240
	}
7241
	function opt_in_jetpack_manage_url() {
7242
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7243
	}
7244
	function opt_in_jetpack_manage_notice() {
7245
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7246
	}
7247
	function can_display_jetpack_manage_notice() {
7248
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7249
	}
7250
7251
	/**
7252
	 * Clean leftoveruser meta.
7253
	 *
7254
	 * Delete Jetpack-related user meta when it is no longer needed.
7255
	 *
7256
	 * @since 7.3.0
7257
	 *
7258
	 * @param int $user_id User ID being updated.
7259
	 */
7260
	public static function user_meta_cleanup( $user_id ) {
7261
		$meta_keys = array(
7262
			// AtD removed from Jetpack 7.3
7263
			'AtD_options',
7264
			'AtD_check_when',
7265
			'AtD_guess_lang',
7266
			'AtD_ignored_phrases',
7267
		);
7268
7269
		foreach ( $meta_keys as $meta_key ) {
7270
			if ( get_user_meta( $user_id, $meta_key ) ) {
7271
				delete_user_meta( $user_id, $meta_key );
7272
			}
7273
		}
7274
	}
7275
7276
	/**
7277
	 * Checks if a Jetpack site is both active and not in offline mode.
7278
	 *
7279
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_offline_mode`.
7280
	 *
7281
	 * @deprecated 8.8.0
7282
	 *
7283
	 * @return bool True if Jetpack is active and not in offline mode.
7284
	 */
7285
	public static function is_active_and_not_development_mode() {
7286
		_deprecated_function( __FUNCTION__, 'jetpack-8.8.0', 'Jetpack::is_active_and_not_offline_mode' );
7287
		if ( ! self::is_active() || ( new Status() )->is_offline_mode() ) {
7288
			return false;
7289
		}
7290
		return true;
7291
	}
7292
7293
	/**
7294
	 * Checks if a Jetpack site is both active and not in offline mode.
7295
	 *
7296
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_offline_mode`.
7297
	 *
7298
	 * @since 8.8.0
7299
	 *
7300
	 * @return bool True if Jetpack is active and not in offline mode.
7301
	 */
7302
	public static function is_active_and_not_offline_mode() {
7303
		if ( ! self::is_active() || ( new Status() )->is_offline_mode() ) {
7304
			return false;
7305
		}
7306
		return true;
7307
	}
7308
7309
	/**
7310
	 * Returns the list of products that we have available for purchase.
7311
	 */
7312
	public static function get_products_for_purchase() {
7313
		$products = array();
7314
		if ( ! is_multisite() ) {
7315
			$products[] = array(
7316
				'key'               => 'backup',
7317
				'title'             => __( 'Jetpack Backup', 'jetpack' ),
7318
				'short_description' => __( 'Always-on backups ensure you never lose your site.', 'jetpack' ),
7319
				'learn_more'        => __( 'Which backup option is best for me?', 'jetpack' ),
7320
				'description'       => __( 'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.', 'jetpack' ),
7321
				'options_label'     => __( 'Select a backup option:', 'jetpack' ),
7322
				'options'           => array(
7323
					array(
7324
						'type'        => 'daily',
7325
						'slug'        => 'jetpack-backup-daily',
7326
						'key'         => 'jetpack_backup_daily',
7327
						'name'        => __( 'Daily Backups', 'jetpack' ),
7328
						'description' => __( 'Your data is being securely backed up daily.', 'jetpack' ),
7329
					),
7330
					array(
7331
						'type'        => 'realtime',
7332
						'slug'        => 'jetpack-backup-realtime',
7333
						'key'         => 'jetpack_backup_realtime',
7334
						'name'        => __( 'Real-Time Backups', 'jetpack' ),
7335
						'description' => __( 'Your data is being securely backed up as you edit.', 'jetpack' ),
7336
					),
7337
				),
7338
				'default_option'    => 'realtime',
7339
				'show_promotion'    => true,
7340
				'discount_percent'  => 70,
7341
				'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'daily-backup-plan', 'realtime-backup-plan' ),
7342
			);
7343
7344
			$products[] = array(
7345
				'key'               => 'scan',
7346
				'title'             => __( 'Jetpack Scan', 'jetpack' ),
7347
				'short_description' => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7348
				'learn_more'        => __( 'Learn More', 'jetpack' ),
7349
				'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7350
				'show_promotion'    => true,
7351
				'discount_percent'  => 30,
7352
				'options'           => array(
7353
					array(
7354
						'type'      => 'scan',
7355
						'slug'      => 'jetpack-scan',
7356
						'key'       => 'jetpack_scan',
7357
						'name'      => __( 'Daily Scan', 'jetpack' ),
7358
					),
7359
				),
7360
				'default_option'    => 'scan',
7361
				'included_in_plans' => array( 'premium-plan', 'business-plan', 'scan-plan' ),
7362
			);
7363
		}
7364
7365
		$products[] = array(
7366
			'key'               => 'search',
7367
			'title'             => __( 'Jetpack Search', 'jetpack' ),
7368
			'short_description' => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7369
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7370
			'description'       => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7371
			'label_popup'  		=> __( 'Records are all posts, pages, custom post types, and other types of content indexed by Jetpack Search.' ),
7372
			'options'           => array(
7373
				array(
7374
					'type'      => 'search',
7375
					'slug'      => 'jetpack-search',
7376
					'key'       => 'jetpack_search',
7377
					'name'      => __( 'Search', 'jetpack' ),
7378
				),
7379
			),
7380
			'tears'             => array(),
7381
			'default_option'    => 'search',
7382
			'show_promotion'    => false,
7383
			'included_in_plans' => array( 'search-plan' ),
7384
		);
7385
7386
		$products[] = array(
7387
			'key'               => 'anti-spam',
7388
			'title'             => __( 'Jetpack Anti-Spam', 'jetpack' ),
7389
			'short_description' => __( 'Automatically clear spam from comments and forms. Save time, get more responses, give your visitors a better experience – all without lifting a finger.', 'jetpack' ),
7390
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7391
			'description'       => __( 'Automatically clear spam from comments and forms. Save time, get more responses, give your visitors a better experience – all without lifting a finger.', 'jetpack' ),
7392
			'options'           => array(
7393
				array(
7394
					'type'      => 'anti-spam',
7395
					'slug'      => 'jetpack-anti-spam',
7396
					'key'       => 'jetpack_anti_spam',
7397
					'name'      => __( 'Anti-Spam', 'jetpack' ),
7398
				),
7399
			),
7400
			'default_option'    => 'anti-spam',
7401
			'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'anti-spam-plan' ),
7402
		);
7403
7404
		return $products;
7405
	}
7406
}
7407