Completed
Push — fix/markdown-parser-breaking-s... ( 6ae5e6...f00a12 )
by Jeremy
222:51 queued 212:00
created

Jetpack::configure()   C

Complexity

Conditions 10
Paths 144

Size

Total Lines 81

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 10
nc 144
nop 0
dl 0
loc 81
rs 6.2545
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

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

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

Commonly applied refactorings include:

1
<?php
2
3
use Automattic\Jetpack\Assets;
4
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
5
use Automattic\Jetpack\Config;
6
use Automattic\Jetpack\Connection\Client;
7
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
8
use Automattic\Jetpack\Connection\Nonce_Handler;
9
use Automattic\Jetpack\Connection\Plugin_Storage as Connection_Plugin_Storage;
10
use Automattic\Jetpack\Connection\Rest_Authentication as Connection_Rest_Authentication;
11
use Automattic\Jetpack\Connection\Secrets;
12
use Automattic\Jetpack\Connection\Tokens;
13
use Automattic\Jetpack\Connection\Webhooks as Connection_Webhooks;
14
use Automattic\Jetpack\Constants;
15
use Automattic\Jetpack\Device_Detection\User_Agent_Info;
16
use Automattic\Jetpack\Licensing;
17
use Automattic\Jetpack\Partner;
18
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
19
use Automattic\Jetpack\Redirect;
20
use Automattic\Jetpack\Status;
21
use Automattic\Jetpack\Sync\Functions;
22
use Automattic\Jetpack\Sync\Health;
23
use Automattic\Jetpack\Sync\Sender;
24
use Automattic\Jetpack\Sync\Users;
25
use Automattic\Jetpack\Terms_Of_Service;
26
use Automattic\Jetpack\Tracking;
27
28
/*
29
Options:
30
jetpack_options (array)
31
	An array of options.
32
	@see Jetpack_Options::get_option_names()
33
34
jetpack_register (string)
35
	Temporary verification secrets.
36
37
jetpack_activated (int)
38
	1: the plugin was activated normally
39
	2: the plugin was activated on this site because of a network-wide activation
40
	3: the plugin was auto-installed
41
	4: the plugin was manually disconnected (but is still installed)
42
43
jetpack_active_modules (array)
44
	Array of active module slugs.
45
46
jetpack_do_activate (bool)
47
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
48
*/
49
50
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
51
52
class Jetpack {
53
	public $xmlrpc_server = null;
54
55
	/**
56
	 * @var array The handles of styles that are concatenated into jetpack.css.
57
	 *
58
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
59
	 */
60
	public $concatenated_style_handles = array(
61
		'jetpack-carousel',
62
		'grunion.css',
63
		'the-neverending-homepage',
64
		'jetpack_likes',
65
		'jetpack_related-posts',
66
		'sharedaddy',
67
		'jetpack-slideshow',
68
		'presentations',
69
		'quiz',
70
		'jetpack-subscriptions',
71
		'jetpack-responsive-videos-style',
72
		'jetpack-social-menu',
73
		'tiled-gallery',
74
		'jetpack_display_posts_widget',
75
		'gravatar-profile-widget',
76
		'goodreads-widget',
77
		'jetpack_social_media_icons_widget',
78
		'jetpack-top-posts-widget',
79
		'jetpack_image_widget',
80
		'jetpack-my-community-widget',
81
		'jetpack-authors-widget',
82
		'wordads',
83
		'eu-cookie-law-style',
84
		'flickr-widget-style',
85
		'jetpack-search-widget',
86
		'jetpack-simple-payments-widget-style',
87
		'jetpack-widget-social-icons-styles',
88
		'wpcom_instagram_widget',
89
	);
90
91
	/**
92
	 * Contains all assets that have had their URL rewritten to minified versions.
93
	 *
94
	 * @var array
95
	 */
96
	static $min_assets = array();
97
98
	public $plugins_to_deactivate = array(
99
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
100
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
101
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
102
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
103
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
104
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
105
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
106
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
107
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
108
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
109
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
110
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
111
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
112
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
113
	);
114
115
	/**
116
	 * Map of roles we care about, and their corresponding minimum capabilities.
117
	 *
118
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
119
	 *
120
	 * @access public
121
	 * @static
122
	 *
123
	 * @var array
124
	 */
125
	public static $capability_translations = array(
126
		'administrator' => 'manage_options',
127
		'editor'        => 'edit_others_posts',
128
		'author'        => 'publish_posts',
129
		'contributor'   => 'edit_posts',
130
		'subscriber'    => 'read',
131
	);
132
133
	/**
134
	 * Map of modules that have conflicts with plugins and should not be auto-activated
135
	 * if the plugins are active.  Used by filter_default_modules
136
	 *
137
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
138
	 * change `module-slug` and add this to your plugin:
139
	 *
140
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
141
	 * function my_jetpack_get_default_modules( $modules ) {
142
	 *     return array_diff( $modules, array( 'module-slug' ) );
143
	 * }
144
	 *
145
	 * @var array
146
	 */
147
	private $conflicting_plugins = array(
148
		'comments'           => array(
149
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
150
			'Disqus'                         => 'disqus-comment-system/disqus.php',
151
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
152
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
153
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
154
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
155
		),
156
		'comment-likes'      => array(
157
			'Epoch' => 'epoch/plugincore.php',
158
		),
159
		'contact-form'       => array(
160
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
161
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
162
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
163
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
164
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
165
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
166
		),
167
		'latex'              => array(
168
			'LaTeX for WordPress'     => 'latex/latex.php',
169
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
170
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
171
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
172
			'Enable Latex'            => 'enable-latex/enable-latex.php',
173
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
174
		),
175
		'protect'            => array(
176
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
177
			'Captcha'                           => 'captcha/captcha.php',
178
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
179
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
180
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
181
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
182
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
183
			'Security-protection'               => 'security-protection/security-protection.php',
184
			'Login Security'                    => 'login-security/login-security.php',
185
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
186
			'Wordfence Security'                => 'wordfence/wordfence.php',
187
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
188
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
189
		),
190
		'random-redirect'    => array(
191
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
192
		),
193
		'related-posts'      => array(
194
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
195
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
196
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
197
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
198
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
199
			'outbrain'                    => 'outbrain/outbrain.php',
200
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
201
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
202
		),
203
		'sharedaddy'         => array(
204
			'AddThis'     => 'addthis/addthis_social_widget.php',
205
			'Add To Any'  => 'add-to-any/add-to-any.php',
206
			'ShareThis'   => 'share-this/sharethis.php',
207
			'Shareaholic' => 'shareaholic/shareaholic.php',
208
		),
209
		'seo-tools'          => array(
210
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
211
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
212
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
213
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
214
			'The SEO Framework'              => 'autodescription/autodescription.php',
215
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
216
			'Slim SEO'                       => 'slim-seo/slim-seo.php',
217
		),
218
		'verification-tools' => array(
219
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
220
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
221
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
222
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
223
			'The SEO Framework'              => 'autodescription/autodescription.php',
224
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
225
			'Slim SEO'                       => 'slim-seo/slim-seo.php',
226
		),
227
		'widget-visibility'  => array(
228
			'Widget Logic'    => 'widget-logic/widget_logic.php',
229
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
230
		),
231
		'sitemaps'           => array(
232
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
233
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
234
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
235
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
236
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
237
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
238
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
239
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
240
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
241
			'The SEO Framework'                    => 'autodescription/autodescription.php',
242
			'Sitemap'                              => 'sitemap/sitemap.php',
243
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
244
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
245
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
246
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
247
			'Rank Math'                            => 'seo-by-rank-math/rank-math.php',
248
			'Slim SEO'                             => 'slim-seo/slim-seo.php',
249
		),
250
		'lazy-images'        => array(
251
			'Lazy Load'              => 'lazy-load/lazy-load.php',
252
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
253
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
254
		),
255
	);
256
257
	/**
258
	 * Plugins for which we turn off our Facebook OG Tags implementation.
259
	 *
260
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
261
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
262
	 *
263
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
264
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
265
	 */
266
	private $open_graph_conflicting_plugins = array(
267
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
268
		// 2 Click Social Media Buttons
269
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
270
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
271
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
272
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
273
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
274
		// Open Graph Meta Tags by Heateor
275
		'facebook/facebook.php',                                 // Facebook (official plugin)
276
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
277
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
278
		// Facebook Featured Image & OG Meta Tags
279
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
280
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
281
		// Facebook Open Graph Meta Tags for WordPress
282
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
283
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
284
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
285
		// Fedmich's Facebook Open Graph Meta
286
		'network-publisher/networkpub.php',                      // Network Publisher
287
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
288
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
289
		// NextScripts SNAP
290
		'og-tags/og-tags.php',                                   // OG Tags
291
		'opengraph/opengraph.php',                               // Open Graph
292
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
293
		// Open Graph Protocol Framework
294
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
295
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
296
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
297
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
298
		'sharepress/sharepress.php',                             // SharePress
299
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
300
		'social-discussions/social-discussions.php',             // Social Discussions
301
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
302
		'socialize/socialize.php',                               // Socialize
303
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
304
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
305
		// Tweet, Like, Google +1 and Share
306
		'wordbooker/wordbooker.php',                             // Wordbooker
307
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
308
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
309
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
310
		// WP Facebook Like Send & Open Graph Meta
311
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
312
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
313
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
314
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
315
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
316
		'seo-by-rank-math/rank-math.php',                        // Rank Math.
317
		'slim-seo/slim-seo.php',                                 // Slim SEO
318
	);
319
320
	/**
321
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
322
	 */
323
	private $twitter_cards_conflicting_plugins = array(
324
		// 'twitter/twitter.php',                       // The official one handles this on its own.
325
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
326
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
327
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
328
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
329
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
330
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
331
		'twitter-cards/twitter-cards.php',           // Twitter Cards
332
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
333
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
334
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
335
		'seo-by-rank-math/rank-math.php',            // Rank Math.
336
		'slim-seo/slim-seo.php',                     // Slim SEO
337
	);
338
339
	/**
340
	 * Message to display in admin_notice
341
	 *
342
	 * @var string
343
	 */
344
	public $message = '';
345
346
	/**
347
	 * Error to display in admin_notice
348
	 *
349
	 * @var string
350
	 */
351
	public $error = '';
352
353
	/**
354
	 * Modules that need more privacy description.
355
	 *
356
	 * @var string
357
	 */
358
	public $privacy_checks = '';
359
360
	/**
361
	 * Stats to record once the page loads
362
	 *
363
	 * @var array
364
	 */
365
	public $stats = array();
366
367
	/**
368
	 * Jetpack_Sync object
369
	 */
370
	public $sync;
371
372
	/**
373
	 * Verified data for JSON authorization request
374
	 */
375
	public $json_api_authorization_request = array();
376
377
	/**
378
	 * @var Automattic\Jetpack\Connection\Manager
379
	 */
380
	protected $connection_manager;
381
382
	/**
383
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
384
	 */
385
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
386
387
	/**
388
	 * Holds an instance of Automattic\Jetpack\A8c_Mc_Stats
389
	 *
390
	 * @var Automattic\Jetpack\A8c_Mc_Stats
391
	 */
392
	public $a8c_mc_stats_instance;
393
394
	/**
395
	 * Constant for login redirect key.
396
	 *
397
	 * @var string
398
	 * @since 8.4.0
399
	 */
400
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
401
402
	/**
403
	 * Holds the singleton instance of this class
404
	 *
405
	 * @since 2.3.3
406
	 * @var Jetpack
407
	 */
408
	static $instance = false;
409
410
	/**
411
	 * Singleton
412
	 *
413
	 * @static
414
	 */
415
	public static function init() {
416
		if ( ! self::$instance ) {
417
			self::$instance = new Jetpack();
418
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
419
		}
420
421
		return self::$instance;
422
	}
423
424
	/**
425
	 * Must never be called statically
426
	 */
427
	function plugin_upgrade() {
428
		if ( self::is_connection_ready() ) {
429
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
430
			if ( JETPACK__VERSION != $version ) {
431
				// Prevent multiple upgrades at once - only a single process should trigger
432
				// an upgrade to avoid stampedes
433
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
434
					return;
435
				}
436
437
				// Set a short lock to prevent multiple instances of the upgrade
438
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
439
440
				// check which active modules actually exist and remove others from active_modules list
441
				$unfiltered_modules = self::get_active_modules();
442
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
443
				if ( array_diff( $unfiltered_modules, $modules ) ) {
444
					self::update_active_modules( $modules );
445
				}
446
447
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
448
449
				// Upgrade to 4.3.0
450
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
451
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
452
				}
453
454
				// Make sure Markdown for posts gets turned back on
455
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
456
					update_option( 'wpcom_publish_posts_with_markdown', true );
457
				}
458
459
				/*
460
				 * Minileven deprecation. 8.3.0.
461
				 * Only delete options if not using
462
				 * the replacement standalone Minileven plugin.
463
				 */
464
				if (
465
					! self::is_plugin_active( 'minileven-master/minileven.php' )
466
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
467
				) {
468
					if ( get_option( 'wp_mobile_custom_css' ) ) {
469
						delete_option( 'wp_mobile_custom_css' );
470
					}
471
					if ( get_option( 'wp_mobile_excerpt' ) ) {
472
						delete_option( 'wp_mobile_excerpt' );
473
					}
474
					if ( get_option( 'wp_mobile_featured_images' ) ) {
475
						delete_option( 'wp_mobile_featured_images' );
476
					}
477
					if ( get_option( 'wp_mobile_app_promos' ) ) {
478
						delete_option( 'wp_mobile_app_promos' );
479
					}
480
				}
481
482
				// Upgrade to 8.4.0.
483
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
484
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
485
				}
486
487
				// Update to 8.8.x (WordPress 5.5 Compatibility).
488
				if ( Jetpack_Options::get_option( 'autoupdate_plugins' ) ) {
489
					$updated = update_site_option(
490
						'auto_update_plugins',
491
						array_unique(
492
							array_merge(
493
								(array) Jetpack_Options::get_option( 'autoupdate_plugins', array() ),
494
								(array) get_site_option( 'auto_update_plugins', array() )
495
							)
496
						)
497
					);
498
499
					if ( $updated ) {
500
						Jetpack_Options::delete_option( 'autoupdate_plugins' );
501
					} // Should we have some type of fallback if something fails here?
502
				}
503
504
				if ( did_action( 'wp_loaded' ) ) {
505
					self::upgrade_on_load();
506
				} else {
507
					add_action(
508
						'wp_loaded',
509
						array( __CLASS__, 'upgrade_on_load' )
510
					);
511
				}
512
			}
513
		}
514
	}
515
516
	/**
517
	 * Runs upgrade routines that need to have modules loaded.
518
	 */
519
	static function upgrade_on_load() {
520
521
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
522
		// This can happen in case Jetpack has been just upgraded and is
523
		// being initialized late during the page load. In this case we wait
524
		// until the next proper admin page load with Jetpack active.
525
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
526
			delete_transient( self::$plugin_upgrade_lock_key );
527
528
			return;
529
		}
530
531
		self::maybe_set_version_option();
532
533
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
534
			Jetpack_Widget_Conditions::migrate_post_type_rules();
535
		}
536
537
		if (
538
			class_exists( 'Jetpack_Sitemap_Manager' )
539
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
540
		) {
541
			do_action( 'jetpack_sitemaps_purge_data' );
542
		}
543
544
		// Delete old stats cache
545
		delete_option( 'jetpack_restapi_stats_cache' );
546
547
		delete_transient( self::$plugin_upgrade_lock_key );
548
	}
549
550
	/**
551
	 * Saves all the currently active modules to options.
552
	 * Also fires Action hooks for each newly activated and deactivated module.
553
	 *
554
	 * @param $modules Array Array of active modules to be saved in options.
555
	 *
556
	 * @return $success bool true for success, false for failure.
0 ignored issues
show
Documentation introduced by
The doc-type $success could not be parsed: Unknown type name "$success" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
557
	 */
558
	static function update_active_modules( $modules ) {
559
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
560
		$active_modules       = self::get_active_modules();
561
		$new_active_modules   = array_diff( $modules, $current_modules );
562
		$new_inactive_modules = array_diff( $active_modules, $modules );
563
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
564
		$reindexed_modules    = array_values( $new_current_modules );
565
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
566
567
		foreach ( $new_active_modules as $module ) {
568
			/**
569
			 * Fires when a specific module is activated.
570
			 *
571
			 * @since 1.9.0
572
			 *
573
			 * @param string $module Module slug.
574
			 * @param boolean $success whether the module was activated. @since 4.2
575
			 */
576
			do_action( 'jetpack_activate_module', $module, $success );
577
			/**
578
			 * Fires when a module is activated.
579
			 * The dynamic part of the filter, $module, is the module slug.
580
			 *
581
			 * @since 1.9.0
582
			 *
583
			 * @param string $module Module slug.
584
			 */
585
			do_action( "jetpack_activate_module_$module", $module );
586
		}
587
588
		foreach ( $new_inactive_modules as $module ) {
589
			/**
590
			 * Fired after a module has been deactivated.
591
			 *
592
			 * @since 4.2.0
593
			 *
594
			 * @param string $module Module slug.
595
			 * @param boolean $success whether the module was deactivated.
596
			 */
597
			do_action( 'jetpack_deactivate_module', $module, $success );
598
			/**
599
			 * Fires when a module is deactivated.
600
			 * The dynamic part of the filter, $module, is the module slug.
601
			 *
602
			 * @since 1.9.0
603
			 *
604
			 * @param string $module Module slug.
605
			 */
606
			do_action( "jetpack_deactivate_module_$module", $module );
607
		}
608
609
		return $success;
610
	}
611
612
	static function delete_active_modules() {
613
		self::update_active_modules( array() );
614
	}
615
616
	/**
617
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
618
	 * available.
619
	 */
620
	public function add_configure_hook() {
621
		global $wp_filter;
622
623
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
624
		if ( false !== $current_priority ) {
625
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
626
		}
627
628
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
629
		sort( $taken_priorities );
630
631
		$first_priority = array_shift( $taken_priorities );
632
633
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
634
			$new_priority = - PHP_INT_MAX;
635
		} else {
636
			$new_priority = $first_priority - 1;
637
		}
638
639
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
640
	}
641
642
	/**
643
	 * Constructor.  Initializes WordPress hooks
644
	 */
645
	private function __construct() {
646
		/*
647
		 * Check for and alert any deprecated hooks
648
		 */
649
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
650
651
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
652
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
653
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
654
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
655
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
656
657
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
658
659
		add_filter(
660
			'jetpack_signature_check_token',
661
			array( __CLASS__, 'verify_onboarding_token' ),
662
			10,
663
			3
664
		);
665
666
		/**
667
		 * Prepare Gutenberg Editor functionality
668
		 */
669
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
670
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
671
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
672
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_extended_blocks' ), 9 );
673
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
674
675
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
676
677
		// Unlink user before deleting the user from WP.com.
678
		add_action( 'deleted_user', array( $this, 'disconnect_user' ), 10, 1 );
679
		add_action( 'remove_user_from_blog', array( $this, 'disconnect_user' ), 10, 1 );
680
681
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
682
683
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
684
		add_action( 'login_init', array( $this, 'login_init' ) );
685
686
		// Set up the REST authentication hooks.
687
		Connection_Rest_Authentication::init();
688
689
		add_action( 'admin_init', array( $this, 'admin_init' ) );
690
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
691
692
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
693
694
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
695
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
696
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
697
698
		// returns HTTPS support status
699
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
700
701
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
702
703
		add_action( 'wp_ajax_jetpack_recommendations_banner', array( 'Jetpack_Recommendations_Banner', 'ajax_callback' ) );
704
705
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
706
707
		/**
708
		 * These actions run checks to load additional files.
709
		 * They check for external files or plugins, so they need to run as late as possible.
710
		 */
711
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
712
		add_action( 'web_stories_story_head', array( $this, 'check_open_graph' ), 1 );
713
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
714
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
715
716
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
717
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
718
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
719
720
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
721
722
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
723
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
724
725
		// A filter to control all just in time messages
726
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
727
728
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
729
730
		require_once JETPACK__PLUGIN_DIR . 'class-jetpack-pre-connection-jitms.php';
731
		$jetpack_jitm_messages = ( new Jetpack_Pre_Connection_JITMs() );
732
		add_filter( 'jetpack_pre_connection_jitms', array( $jetpack_jitm_messages, 'add_pre_connection_jitms' ) );
733
734
		/*
735
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
736
		 * We should make sure to only do this for front end links.
737
		 */
738
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
739
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
740
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
741
742
			/*
743
			 * We'll shortcircuit wp_notify_postauthor and wp_notify_moderator pluggable functions
744
			 * so they point moderation links on emails to Calypso.
745
			 */
746
			jetpack_require_lib( 'functions.wp-notify' );
747
			add_filter( 'comment_notification_recipients', 'jetpack_notify_postauthor', 1, 2 );
748
			add_filter( 'notify_moderator', 'jetpack_notify_moderator', 1, 2 );
749
		}
750
751
		add_action(
752
			'plugins_loaded',
753
			function () {
754
				if ( User_Agent_Info::is_mobile_app() ) {
755
					add_filter( 'get_edit_post_link', '__return_empty_string' );
756
				}
757
			}
758
		);
759
760
		// Update the site's Jetpack plan and products from API on heartbeats.
761
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
762
763
		/**
764
		 * This is the hack to concatenate all css files into one.
765
		 * For description and reasoning see the implode_frontend_css method.
766
		 *
767
		 * Super late priority so we catch all the registered styles.
768
		 */
769
		if ( ! is_admin() ) {
770
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
771
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
772
		}
773
774
		/**
775
		 * These are sync actions that we need to keep track of for jitms
776
		 */
777
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
778
779
		// Actually push the stats on shutdown.
780
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
781
			add_action( 'shutdown', array( $this, 'push_stats' ) );
782
		}
783
784
		// After a successful connection.
785
		add_action( 'jetpack_site_registered', array( $this, 'activate_default_modules_on_site_register' ) );
786
787
		// Actions for Manager::authorize().
788
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
789
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
790
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
791
792
		add_action( 'jetpack_client_authorize_error', array( Jetpack_Client_Server::class, 'client_authorize_error' ) );
793
		add_filter( 'jetpack_client_authorize_already_authorized_url', array( Jetpack_Client_Server::class, 'client_authorize_already_authorized_url' ) );
794
		add_action( 'jetpack_client_authorize_processing', array( Jetpack_Client_Server::class, 'client_authorize_processing' ) );
795
		add_filter( 'jetpack_client_authorize_fallback_url', array( Jetpack_Client_Server::class, 'client_authorize_fallback_url' ) );
796
797
		// Filters for the Manager::get_token() urls and request body.
798
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
799
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
800
801
		// Actions for successful reconnect.
802
		add_action( 'jetpack_reconnection_completed', array( $this, 'reconnection_completed' ) );
803
804
		// Actions for licensing.
805
		Licensing::instance()->initialize();
806
807
		// Filters for Sync Callables.
808
		add_filter( 'jetpack_sync_callable_whitelist', array( $this, 'filter_sync_callable_whitelist' ), 10, 1 );
809
		add_filter( 'jetpack_sync_multisite_callable_whitelist', array( $this, 'filter_sync_multisite_callable_whitelist' ), 10, 1 );
810
811
		// Make resources use static domain when possible.
812
		add_filter( 'jetpack_static_url', array( 'Automattic\\Jetpack\\Assets', 'staticize_subdomain' ) );
813
	}
814
815
	/**
816
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
817
	 * Config object.
818
	 */
819
	public function configure() {
820
		$config = new Config();
821
822
		foreach (
823
			array(
824
				'sync',
825
				'jitm',
826
			)
827
			as $feature
828
		) {
829
			$config->ensure( $feature );
830
		}
831
832
		$config->ensure(
833
			'connection',
834
			array(
835
				'slug' => 'jetpack',
836
				'name' => 'Jetpack',
837
			)
838
		);
839
840
		if ( ! $this->connection_manager ) {
841
			$this->connection_manager = new Connection_Manager( 'jetpack' );
842
843
			/**
844
			 * Filter to activate Jetpack Connection UI.
845
			 * INTERNAL USE ONLY.
846
			 *
847
			 * @since 9.5.0
848
			 *
849
			 * @param bool false Whether to activate the Connection UI.
850
			 */
851
			if ( apply_filters( 'jetpack_connection_ui_active', false ) ) {
852
				Automattic\Jetpack\ConnectionUI\Admin::init();
853
			}
854
		}
855
856
		/*
857
		 * Load things that should only be in Network Admin.
858
		 *
859
		 * For now blow away everything else until a more full
860
		 * understanding of what is needed at the network level is
861
		 * available
862
		 */
863
		if ( is_multisite() ) {
864
			$network = Jetpack_Network::init();
865
			$network->set_connection( $this->connection_manager );
866
		}
867
868
		if ( self::is_connection_ready() ) {
869
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
870
871
			Jetpack_Heartbeat::init();
872
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
873
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
874
				Jetpack_Search_Performance_Logger::init();
875
			}
876
		}
877
878
		// Initialize remote file upload request handlers.
879
		$this->add_remote_request_handlers();
880
881
		/*
882
		 * Enable enhanced handling of previewing sites in Calypso
883
		 */
884
		if ( self::is_connection_ready() ) {
885
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
886
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
887
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
888
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
889
		}
890
891
		if ( ( new Tracking( $this->connection_manager ) )->should_enable_tracking( new Terms_Of_Service(), new Status() ) ) {
0 ignored issues
show
Documentation introduced by
$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...
Documentation introduced by
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...
Documentation introduced by
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...
892
			add_action( 'init', array( new Plugin_Tracking(), 'init' ) );
893
		} else {
894
			/**
895
			 * Initialize tracking right after the user agrees to the terms of service.
896
			 */
897
			add_action( 'jetpack_agreed_to_terms_of_service', array( new Plugin_Tracking(), 'init' ) );
898
		}
899
	}
900
901
	/**
902
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
903
	 * initialization code.
904
	 *
905
	 * @action plugins_loaded
906
	 */
907
	public function late_initialization() {
908
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
909
910
		Partner::init();
911
912
		/**
913
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
914
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
915
		 *
916
		 * @since 8.1.0
917
		 *
918
		 * @param Jetpack $jetpack the main plugin class object.
919
		 */
920
		do_action( 'jetpack_loaded', $this );
921
922
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
923
	}
924
925
	/**
926
	 * Sets up the XMLRPC request handlers.
927
	 *
928
	 * @deprecated since 7.7.0
929
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
930
	 *
931
	 * @param array                 $request_params Incoming request parameters.
932
	 * @param Boolean               $is_active      Whether the connection is currently active.
933
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
934
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $xmlrpc_server not be null|Jetpack_XMLRPC_Server?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
935
	 */
936 View Code Duplication
	public function setup_xmlrpc_handlers(
937
		$request_params,
938
		$is_active,
939
		$is_signed,
940
		Jetpack_XMLRPC_Server $xmlrpc_server = null
941
	) {
942
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
943
944
		if ( ! $this->connection_manager ) {
945
			$this->connection_manager = new Connection_Manager();
946
		}
947
948
		return $this->connection_manager->setup_xmlrpc_handlers(
949
			$request_params,
950
			$is_active,
951
			$is_signed,
952
			$xmlrpc_server
953
		);
954
	}
955
956
	/**
957
	 * Initialize REST API registration connector.
958
	 *
959
	 * @deprecated since 7.7.0
960
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
961
	 */
962 View Code Duplication
	public function initialize_rest_api_registration_connector() {
963
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
964
965
		if ( ! $this->connection_manager ) {
966
			$this->connection_manager = new Connection_Manager();
967
		}
968
969
		$this->connection_manager->initialize_rest_api_registration_connector();
970
	}
971
972
	/**
973
	 * This is ported over from the manage module, which has been deprecated and baked in here.
974
	 *
975
	 * @param $domains
976
	 */
977
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
978
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
979
	}
980
981
	/**
982
	 * Return $domains, with 'wordpress.com' appended.
983
	 * This is ported over from the manage module, which has been deprecated and baked in here.
984
	 *
985
	 * @param $domains
986
	 * @return array
987
	 */
988
	function allow_wpcom_domain( $domains ) {
989
		if ( empty( $domains ) ) {
990
			$domains = array();
991
		}
992
		$domains[] = 'wordpress.com';
993
		return array_unique( $domains );
994
	}
995
996
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
997
		$post = get_post( $post_id );
998
999
		if ( empty( $post ) ) {
1000
			return $default_url;
1001
		}
1002
1003
		$post_type = $post->post_type;
1004
1005
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
1006
		// https://en.support.wordpress.com/custom-post-types/
1007
		$allowed_post_types = array(
1008
			'post',
1009
			'page',
1010
			'jetpack-portfolio',
1011
			'jetpack-testimonial',
1012
		);
1013
1014
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
1015
			return $default_url;
1016
		}
1017
1018
		return Redirect::get_url(
1019
			'calypso-edit-' . $post_type,
1020
			array(
1021
				'path' => $post_id,
1022
			)
1023
		);
1024
	}
1025
1026
	function point_edit_comment_links_to_calypso( $url ) {
1027
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
1028
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
1029
1030
		return Redirect::get_url(
1031
			'calypso-edit-comment',
1032
			array(
1033
				'path' => $query_args['amp;c'],
1034
			)
1035
		);
1036
1037
	}
1038
1039
	/**
1040
	 * Extend Sync callables with Jetpack Plugin functions.
1041
	 *
1042
	 * @param array $callables list of callables.
1043
	 *
1044
	 * @return array list of callables.
1045
	 */
1046
	public function filter_sync_callable_whitelist( $callables ) {
1047
1048
		// Jetpack Functions.
1049
		$jetpack_callables = array(
1050
			'single_user_site'         => array( 'Jetpack', 'is_single_user_site' ),
1051
			'updates'                  => array( 'Jetpack', 'get_updates' ),
1052
			'active_modules'           => array( 'Jetpack', 'get_active_modules' ),
1053
			'available_jetpack_blocks' => array( 'Jetpack_Gutenberg', 'get_availability' ), // Includes both Gutenberg blocks *and* plugins.
1054
		);
1055
		$callables         = array_merge( $callables, $jetpack_callables );
1056
1057
		// Jetpack_SSO_Helpers.
1058
		if ( include_once JETPACK__PLUGIN_DIR . 'modules/sso/class.jetpack-sso-helpers.php' ) {
1059
			$sso_helpers = array(
1060
				'sso_is_two_step_required'      => array( 'Jetpack_SSO_Helpers', 'is_two_step_required' ),
1061
				'sso_should_hide_login_form'    => array( 'Jetpack_SSO_Helpers', 'should_hide_login_form' ),
1062
				'sso_match_by_email'            => array( 'Jetpack_SSO_Helpers', 'match_by_email' ),
1063
				'sso_new_user_override'         => array( 'Jetpack_SSO_Helpers', 'new_user_override' ),
1064
				'sso_bypass_default_login_form' => array( 'Jetpack_SSO_Helpers', 'bypass_login_forward_wpcom' ),
1065
			);
1066
			$callables   = array_merge( $callables, $sso_helpers );
1067
		}
1068
1069
		return $callables;
1070
	}
1071
1072
	/**
1073
	 * Extend Sync multisite callables with Jetpack Plugin functions.
1074
	 *
1075
	 * @param array $callables list of callables.
1076
	 *
1077
	 * @return array list of callables.
1078
	 */
1079
	public function filter_sync_multisite_callable_whitelist( $callables ) {
1080
1081
		// Jetpack Funtions.
1082
		$jetpack_multisite_callables = array(
1083
			'network_name'                        => array( 'Jetpack', 'network_name' ),
1084
			'network_allow_new_registrations'     => array( 'Jetpack', 'network_allow_new_registrations' ),
1085
			'network_add_new_users'               => array( 'Jetpack', 'network_add_new_users' ),
1086
			'network_site_upload_space'           => array( 'Jetpack', 'network_site_upload_space' ),
1087
			'network_upload_file_types'           => array( 'Jetpack', 'network_upload_file_types' ),
1088
			'network_enable_administration_menus' => array( 'Jetpack', 'network_enable_administration_menus' ),
1089
		);
1090
		$callables                   = array_merge( $callables, $jetpack_multisite_callables );
1091
1092
		return $callables;
1093
	}
1094
1095
	function jetpack_track_last_sync_callback( $params ) {
1096
		/**
1097
		 * Filter to turn off jitm caching
1098
		 *
1099
		 * @since 5.4.0
1100
		 *
1101
		 * @param bool false Whether to cache just in time messages
1102
		 */
1103
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
1104
			return $params;
1105
		}
1106
1107
		if ( is_array( $params ) && isset( $params[0] ) ) {
1108
			$option = $params[0];
1109
			if ( 'active_plugins' === $option ) {
1110
				// use the cache if we can, but not terribly important if it gets evicted
1111
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
1112
			}
1113
		}
1114
1115
		return $params;
1116
	}
1117
1118
	function jetpack_connection_banner_callback() {
1119
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
1120
1121
		// Disable the banner dismiss functionality if the pre-connection prompt helpers filter is set.
1122
		if (
1123
			isset( $_REQUEST['dismissBanner'] ) &&
1124
			! Jetpack_Connection_Banner::force_display()
1125
		) {
1126
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
1127
			wp_send_json_success();
1128
		}
1129
1130
		wp_die();
1131
	}
1132
1133
	/**
1134
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1135
	 * Only used in our alternate XML-RPC endpoint, where we want to
1136
	 * ensure that Core and other plugins' methods are not exposed.
1137
	 *
1138
	 * @deprecated since 7.7.0
1139
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1140
	 *
1141
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1142
	 * @return array Filtered $methods
1143
	 */
1144 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1145
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1146
1147
		if ( ! $this->connection_manager ) {
1148
			$this->connection_manager = new Connection_Manager();
1149
		}
1150
1151
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1152
	}
1153
1154
	/**
1155
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1156
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1157
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1158
	 * which is accessible via a different URI. Most of the below is copied directly
1159
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1160
	 *
1161
	 * @deprecated since 7.7.0
1162
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1163
	 */
1164 View Code Duplication
	public function alternate_xmlrpc() {
1165
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1166
1167
		if ( ! $this->connection_manager ) {
1168
			$this->connection_manager = new Connection_Manager();
1169
		}
1170
1171
		$this->connection_manager->alternate_xmlrpc();
1172
	}
1173
1174
	/**
1175
	 * The callback for the JITM ajax requests.
1176
	 *
1177
	 * @deprecated since 7.9.0
1178
	 */
1179
	function jetpack_jitm_ajax_callback() {
1180
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1181
	}
1182
1183
	/**
1184
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1185
	 */
1186
	function push_stats() {
1187
		if ( ! empty( $this->stats ) ) {
1188
			$this->do_stats( 'server_side' );
1189
		}
1190
	}
1191
1192
	/**
1193
	 * Sets the Jetpack custom capabilities.
1194
	 *
1195
	 * @param string[] $caps    Array of the user's capabilities.
1196
	 * @param string   $cap     Capability name.
1197
	 * @param int      $user_id The user ID.
1198
	 * @param array    $args    Adds the context to the cap. Typically the object ID.
1199
	 */
1200
	public function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1201
		switch ( $cap ) {
1202
			case 'jetpack_manage_modules':
1203
			case 'jetpack_activate_modules':
1204
			case 'jetpack_deactivate_modules':
1205
				$caps = array( 'manage_options' );
1206
				break;
1207
			case 'jetpack_configure_modules':
1208
				$caps = array( 'manage_options' );
1209
				break;
1210
			case 'jetpack_manage_autoupdates':
1211
				$caps = array(
1212
					'manage_options',
1213
					'update_plugins',
1214
				);
1215
				break;
1216
			case 'jetpack_network_admin_page':
1217
			case 'jetpack_network_settings_page':
1218
				$caps = array( 'manage_network_plugins' );
1219
				break;
1220
			case 'jetpack_network_sites_page':
1221
				$caps = array( 'manage_sites' );
1222
				break;
1223 View Code Duplication
			case 'jetpack_admin_page':
1224
				$is_offline_mode = ( new Status() )->is_offline_mode();
1225
				if ( $is_offline_mode ) {
1226
					$caps = array( 'manage_options' );
1227
					break;
1228
				} else {
1229
					$caps = array( 'read' );
1230
				}
1231
				break;
1232
		}
1233
		return $caps;
1234
	}
1235
1236
	/**
1237
	 * Require a Jetpack authentication.
1238
	 *
1239
	 * @deprecated since 7.7.0
1240
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1241
	 */
1242 View Code Duplication
	public function require_jetpack_authentication() {
1243
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1244
1245
		if ( ! $this->connection_manager ) {
1246
			$this->connection_manager = new Connection_Manager();
1247
		}
1248
1249
		$this->connection_manager->require_jetpack_authentication();
1250
	}
1251
1252
	/**
1253
	 * Register assets for use in various modules and the Jetpack admin page.
1254
	 *
1255
	 * @uses wp_script_is, wp_register_script, plugins_url
1256
	 * @action wp_loaded
1257
	 * @return null
1258
	 */
1259
	public function register_assets() {
1260 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1261
			wp_register_script(
1262
				'jetpack-gallery-settings',
1263
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1264
				array( 'media-views' ),
1265
				'20121225'
1266
			);
1267
		}
1268
1269
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1270
			wp_register_script(
1271
				'jetpack-twitter-timeline',
1272
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1273
				array( 'jquery' ),
1274
				'4.0.0',
1275
				true
1276
			);
1277
		}
1278
1279
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1280
			wp_register_script(
1281
				'jetpack-facebook-embed',
1282
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1283
				array(),
1284
				null,
1285
				true
1286
			);
1287
1288
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1289
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1290
			if ( ! is_numeric( $fb_app_id ) ) {
1291
				$fb_app_id = '';
1292
			}
1293
			wp_localize_script(
1294
				'jetpack-facebook-embed',
1295
				'jpfbembed',
1296
				array(
1297
					'appid'  => $fb_app_id,
1298
					'locale' => $this->get_locale(),
1299
				)
1300
			);
1301
		}
1302
1303
		/**
1304
		 * As jetpack_register_genericons is by default fired off a hook,
1305
		 * the hook may have already fired by this point.
1306
		 * So, let's just trigger it manually.
1307
		 */
1308
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1309
		jetpack_register_genericons();
1310
1311
		/**
1312
		 * Register the social logos
1313
		 */
1314
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1315
		jetpack_register_social_logos();
1316
1317 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1318
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1319
		}
1320
	}
1321
1322
	/**
1323
	 * Guess locale from language code.
1324
	 *
1325
	 * @param string $lang Language code.
1326
	 * @return string|bool
1327
	 */
1328 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1329
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1330
			return 'en_US';
1331
		}
1332
1333
		if ( ! class_exists( 'GP_Locales' ) ) {
1334
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1335
				return false;
1336
			}
1337
1338
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1339
		}
1340
1341
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1342
			// WP.com: get_locale() returns 'it'
1343
			$locale = GP_Locales::by_slug( $lang );
1344
		} else {
1345
			// Jetpack: get_locale() returns 'it_IT';
1346
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1347
		}
1348
1349
		if ( ! $locale ) {
1350
			return false;
1351
		}
1352
1353
		if ( empty( $locale->facebook_locale ) ) {
1354
			if ( empty( $locale->wp_locale ) ) {
1355
				return false;
1356
			} else {
1357
				// Facebook SDK is smart enough to fall back to en_US if a
1358
				// locale isn't supported. Since supported Facebook locales
1359
				// can fall out of sync, we'll attempt to use the known
1360
				// wp_locale value and rely on said fallback.
1361
				return $locale->wp_locale;
1362
			}
1363
		}
1364
1365
		return $locale->facebook_locale;
1366
	}
1367
1368
	/**
1369
	 * Get the locale.
1370
	 *
1371
	 * @return string|bool
1372
	 */
1373
	function get_locale() {
1374
		$locale = $this->guess_locale_from_lang( get_locale() );
1375
1376
		if ( ! $locale ) {
1377
			$locale = 'en_US';
1378
		}
1379
1380
		return $locale;
1381
	}
1382
1383
	/**
1384
	 * Return the network_site_url so that .com knows what network this site is a part of.
1385
	 *
1386
	 * @param  bool $option
1387
	 * @return string
1388
	 */
1389
	public function jetpack_main_network_site_option( $option ) {
1390
		return network_site_url();
1391
	}
1392
	/**
1393
	 * Network Name.
1394
	 */
1395
	static function network_name( $option = null ) {
1396
		global $current_site;
1397
		return $current_site->site_name;
1398
	}
1399
	/**
1400
	 * Does the network allow new user and site registrations.
1401
	 *
1402
	 * @return string
1403
	 */
1404
	static function network_allow_new_registrations( $option = null ) {
1405
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1406
	}
1407
	/**
1408
	 * Does the network allow admins to add new users.
1409
	 *
1410
	 * @return boolian
1411
	 */
1412
	static function network_add_new_users( $option = null ) {
1413
		return (bool) get_site_option( 'add_new_users' );
1414
	}
1415
	/**
1416
	 * File upload psace left per site in MB.
1417
	 *  -1 means NO LIMIT.
1418
	 *
1419
	 * @return number
1420
	 */
1421
	static function network_site_upload_space( $option = null ) {
1422
		// value in MB
1423
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1424
	}
1425
1426
	/**
1427
	 * Network allowed file types.
1428
	 *
1429
	 * @return string
1430
	 */
1431
	static function network_upload_file_types( $option = null ) {
1432
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1433
	}
1434
1435
	/**
1436
	 * Maximum file upload size set by the network.
1437
	 *
1438
	 * @return number
1439
	 */
1440
	static function network_max_upload_file_size( $option = null ) {
1441
		// value in KB
1442
		return get_site_option( 'fileupload_maxk', 300 );
1443
	}
1444
1445
	/**
1446
	 * Lets us know if a site allows admins to manage the network.
1447
	 *
1448
	 * @return array
1449
	 */
1450
	static function network_enable_administration_menus( $option = null ) {
1451
		return get_site_option( 'menu_items' );
1452
	}
1453
1454
	/**
1455
	 * If a user has been promoted to or demoted from admin, we need to clear the
1456
	 * jetpack_other_linked_admins transient.
1457
	 *
1458
	 * @since 4.3.2
1459
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1460
	 *
1461
	 * @param int    $user_id   The user ID whose role changed.
1462
	 * @param string $role      The new role.
1463
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $old_roles not be array|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
1464
	 */
1465
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1466
		if ( 'administrator' == $role
1467
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1468
			|| is_null( $old_roles )
1469
		) {
1470
			delete_transient( 'jetpack_other_linked_admins' );
1471
		}
1472
	}
1473
1474
	/**
1475
	 * Checks to see if there are any other users available to become primary
1476
	 * Users must both:
1477
	 * - Be linked to wpcom
1478
	 * - Be an admin
1479
	 *
1480
	 * @return mixed False if no other users are linked, Int if there are.
1481
	 */
1482
	static function get_other_linked_admins() {
1483
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1484
1485
		if ( false === $other_linked_users ) {
1486
			$admins = get_users( array( 'role' => 'administrator' ) );
1487
			if ( count( $admins ) > 1 ) {
1488
				$available = array();
1489
				foreach ( $admins as $admin ) {
1490
					if ( self::connection()->is_user_connected( $admin->ID ) ) {
1491
						$available[] = $admin->ID;
1492
					}
1493
				}
1494
1495
				$count_connected_admins = count( $available );
1496
				if ( count( $available ) > 1 ) {
1497
					$other_linked_users = $count_connected_admins;
1498
				} else {
1499
					$other_linked_users = 0;
1500
				}
1501
			} else {
1502
				$other_linked_users = 0;
1503
			}
1504
1505
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1506
		}
1507
1508
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1509
	}
1510
1511
	/**
1512
	 * Return whether we are dealing with a multi network setup or not.
1513
	 * The reason we are type casting this is because we want to avoid the situation where
1514
	 * the result is false since when is_main_network_option return false it cases
1515
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1516
	 * database which could be set to anything as opposed to what this function returns.
1517
	 *
1518
	 * @param  bool $option
1519
	 *
1520
	 * @return boolean
1521
	 */
1522
	public function is_main_network_option( $option ) {
1523
		// return '1' or ''
1524
		return (string) (bool) self::is_multi_network();
1525
	}
1526
1527
	/**
1528
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1529
	 *
1530
	 * @param  string $option
1531
	 * @return boolean
1532
	 */
1533
	public function is_multisite( $option ) {
1534
		return (string) (bool) is_multisite();
1535
	}
1536
1537
	/**
1538
	 * Implemented since there is no core is multi network function
1539
	 * Right now there is no way to tell if we which network is the dominant network on the system
1540
	 *
1541
	 * @since  3.3
1542
	 * @return boolean
1543
	 */
1544 View Code Duplication
	public static function is_multi_network() {
1545
		global  $wpdb;
1546
1547
		// if we don't have a multi site setup no need to do any more
1548
		if ( ! is_multisite() ) {
1549
			return false;
1550
		}
1551
1552
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1553
		if ( $num_sites > 1 ) {
1554
			return true;
1555
		} else {
1556
			return false;
1557
		}
1558
	}
1559
1560
	/**
1561
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1562
	 *
1563
	 * @return null
1564
	 */
1565
	function update_jetpack_main_network_site_option() {
1566
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1567
	}
1568
	/**
1569
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1570
	 */
1571
	function update_jetpack_network_settings() {
1572
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1573
		// Only sync this info for the main network site.
1574
	}
1575
1576
	/**
1577
	 * Get back if the current site is single user site.
1578
	 *
1579
	 * @return bool
1580
	 */
1581 View Code Duplication
	public static function is_single_user_site() {
1582
		global $wpdb;
1583
1584
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1585
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1586
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1587
		}
1588
		return 1 === (int) $some_users;
1589
	}
1590
1591
	/**
1592
	 * Returns true if the site has file write access false otherwise.
1593
	 *
1594
	 * @return string ( '1' | '0' )
1595
	 **/
1596
	public static function file_system_write_access() {
1597
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1598
			require_once ABSPATH . 'wp-admin/includes/file.php';
1599
		}
1600
1601
		require_once ABSPATH . 'wp-admin/includes/template.php';
1602
1603
		$filesystem_method = get_filesystem_method();
1604
		if ( $filesystem_method === 'direct' ) {
1605
			return 1;
1606
		}
1607
1608
		ob_start();
1609
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1610
		ob_end_clean();
1611
		if ( $filesystem_credentials_are_stored ) {
1612
			return 1;
1613
		}
1614
		return 0;
1615
	}
1616
1617
	/**
1618
	 * Finds out if a site is using a version control system.
1619
	 *
1620
	 * @return string ( '1' | '0' )
1621
	 **/
1622
	public static function is_version_controlled() {
1623
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1624
		return (string) (int) Functions::is_version_controlled();
1625
	}
1626
1627
	/**
1628
	 * Determines whether the current theme supports featured images or not.
1629
	 *
1630
	 * @return string ( '1' | '0' )
1631
	 */
1632
	public static function featured_images_enabled() {
1633
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1634
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1635
	}
1636
1637
	/**
1638
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1639
	 *
1640
	 * @deprecated 4.7 use get_avatar_url instead.
1641
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1642
	 * @param int               $size Size of the avatar image
1643
	 * @param string            $default URL to a default image to use if no avatar is available
1644
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1645
	 *
1646
	 * @return array
1647
	 */
1648
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1649
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1650
		return get_avatar_url(
1651
			$id_or_email,
1652
			array(
1653
				'size'          => $size,
1654
				'default'       => $default,
1655
				'force_default' => $force_display,
1656
			)
1657
		);
1658
	}
1659
// phpcs:disable WordPress.WP.CapitalPDangit.Misspelled
1660
	/**
1661
	 * jetpack_updates is saved in the following schema:
1662
	 *
1663
	 * array (
1664
	 *      'plugins'                       => (int) Number of plugin updates available.
1665
	 *      'themes'                        => (int) Number of theme updates available.
1666
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1667
	 *      'translations'                  => (int) Number of translation updates available.
1668
	 *      'total'                         => (int) Total of all available updates.
1669
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1670
	 * )
1671
	 *
1672
	 * @return array
1673
	 */
1674
	public static function get_updates() {
1675
		$update_data = wp_get_update_data();
1676
1677
		// Stores the individual update counts as well as the total count.
1678
		if ( isset( $update_data['counts'] ) ) {
1679
			$updates = $update_data['counts'];
1680
		}
1681
1682
		// If we need to update WordPress core, let's find the latest version number.
1683 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1684
			$cur = get_preferred_from_update_core();
1685
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1686
				$updates['wp_update_version'] = $cur->current;
1687
			}
1688
		}
1689
		return isset( $updates ) ? $updates : array();
1690
	}
1691
	// phpcs:enable
1692
1693
	public static function get_update_details() {
1694
		$update_details = array(
1695
			'update_core'    => get_site_transient( 'update_core' ),
1696
			'update_plugins' => get_site_transient( 'update_plugins' ),
1697
			'update_themes'  => get_site_transient( 'update_themes' ),
1698
		);
1699
		return $update_details;
1700
	}
1701
1702
	public static function refresh_update_data() {
1703
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1704
1705
	}
1706
1707
	public static function refresh_theme_data() {
1708
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1709
	}
1710
1711
	/**
1712
	 * Is Jetpack active?
1713
	 * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1714
	 *
1715
	 * This method is deprecated since 9.6.0. Please use one of the methods provided by the Manager class in the Connection package,
1716
	 * or Jetpack::is_connection_ready if you want to know when the Jetpack plugin starts considering the connection ready to be used.
1717
	 *
1718
	 * Since this method has a wide spread use, we decided not to throw any deprecation warnings for now.
1719
	 *
1720
	 * @deprecated 9.6.0
1721
	 *
1722
	 * @return bool
1723
	 */
1724
	public static function is_active() {
1725
		return self::connection()->is_active();
0 ignored issues
show
Deprecated Code introduced by
The method Automattic\Jetpack\Connection\Manager::is_active() has been deprecated with message: 9.6.0

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...
1726
	}
1727
1728
	/**
1729
	 * Returns true if the current site is connected to WordPress.com and has the minimum requirements to enable Jetpack UI
1730
	 *
1731
	 * This method was introduced just before the release of the possibility to use Jetpack without a user connection, while
1732
	 * it was available only when no_user_testing_mode was enabled. In the near future, this will return is_connected for all
1733
	 * users and this option will be available by default for everybody.
1734
	 *
1735
	 * @since 9.6.0
1736
	 *
1737
	 * @return bool is the site connection ready to be used?
1738
	 */
1739
	public static function is_connection_ready() {
1740
		if ( ( new Status() )->is_no_user_testing_mode() ) {
1741
			return self::connection()->is_connected();
1742
		}
1743
		return (bool) self::connection()->has_connected_owner();
1744
	}
1745
1746
	/**
1747
	 * Make an API call to WordPress.com for plan status
1748
	 *
1749
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1750
	 *
1751
	 * @return bool True if plan is updated, false if no update
1752
	 */
1753
	public static function refresh_active_plan_from_wpcom() {
1754
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1755
		return Jetpack_Plan::refresh_from_wpcom();
1756
	}
1757
1758
	/**
1759
	 * Get the plan that this Jetpack site is currently using
1760
	 *
1761
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1762
	 * @return array Active Jetpack plan details.
1763
	 */
1764
	public static function get_active_plan() {
1765
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1766
		return Jetpack_Plan::get();
1767
	}
1768
1769
	/**
1770
	 * Determine whether the active plan supports a particular feature
1771
	 *
1772
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1773
	 * @return bool True if plan supports feature, false if not.
1774
	 */
1775
	public static function active_plan_supports( $feature ) {
1776
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1777
		return Jetpack_Plan::supports( $feature );
1778
	}
1779
1780
	/**
1781
	 * Deprecated: Is Jetpack in development (offline) mode?
1782
	 *
1783
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1784
	 * and themes still use it, and we do not want to flood them with notices.
1785
	 *
1786
	 * Please use Automattic\Jetpack\Status()->is_offline_mode() instead.
1787
	 *
1788
	 * @deprecated since 8.0.
1789
	 */
1790
	public static function is_development_mode() {
1791
		_deprecated_function( __METHOD__, 'jetpack-8.0', '\Automattic\Jetpack\Status->is_offline_mode' );
1792
		return ( new Status() )->is_offline_mode();
1793
	}
1794
1795
	/**
1796
	 * Whether the site is currently onboarding or not.
1797
	 * A site is considered as being onboarded if it currently has an onboarding token.
1798
	 *
1799
	 * @since 5.8
1800
	 *
1801
	 * @access public
1802
	 * @static
1803
	 *
1804
	 * @return bool True if the site is currently onboarding, false otherwise
1805
	 */
1806
	public static function is_onboarding() {
1807
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1808
	}
1809
1810
	/**
1811
	 * Determines reason for Jetpack offline mode.
1812
	 */
1813
	public static function development_mode_trigger_text() {
1814
		$status = new Status();
1815
1816
		if ( ! $status->is_offline_mode() ) {
1817
			return __( 'Jetpack is not in Offline Mode.', 'jetpack' );
1818
		}
1819
1820
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1821
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1822
		} elseif ( defined( 'WP_LOCAL_DEV' ) && WP_LOCAL_DEV ) {
1823
			$notice = __( 'The WP_LOCAL_DEV constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1824
		} elseif ( $status->is_local_site() ) {
1825
			$notice = __( 'The site URL is a known local development environment URL (e.g. http://localhost).', 'jetpack' );
1826
			/** This filter is documented in packages/status/src/class-status.php */
1827
		} elseif ( has_filter( 'jetpack_development_mode' ) && apply_filters( 'jetpack_development_mode', false ) ) { // This is a deprecated filter name.
1828
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1829
		} else {
1830
			$notice = __( 'The jetpack_offline_mode filter is set to true.', 'jetpack' );
1831
		}
1832
1833
		return $notice;
1834
1835
	}
1836
	/**
1837
	 * Get Jetpack offline mode notice text and notice class.
1838
	 *
1839
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_offline_mode
1840
	 */
1841
	public static function show_development_mode_notice() {
1842 View Code Duplication
		if ( ( new Status() )->is_offline_mode() ) {
1843
			$notice = sprintf(
1844
				/* translators: %s is a URL */
1845
				__( 'In <a href="%s" target="_blank">Offline Mode</a>:', 'jetpack' ),
1846
				Redirect::get_url( 'jetpack-support-development-mode' )
1847
			);
1848
1849
			$notice .= ' ' . self::development_mode_trigger_text();
1850
1851
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1852
		}
1853
1854
		// Throw up a notice if using a development version and as for feedback.
1855
		if ( self::is_development_version() ) {
1856
			/* translators: %s is a URL */
1857
			$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' ) );
1858
1859
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1860
		}
1861
		// Throw up a notice if using staging mode
1862 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1863
			/* translators: %s is a URL */
1864
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1865
1866
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1867
		}
1868
	}
1869
1870
	/**
1871
	 * Whether Jetpack's version maps to a public release, or a development version.
1872
	 */
1873
	public static function is_development_version() {
1874
		/**
1875
		 * Allows filtering whether this is a development version of Jetpack.
1876
		 *
1877
		 * This filter is especially useful for tests.
1878
		 *
1879
		 * @since 4.3.0
1880
		 *
1881
		 * @param bool $development_version Is this a develoment version of Jetpack?
1882
		 */
1883
		return (bool) apply_filters(
1884
			'jetpack_development_version',
1885
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1886
		);
1887
	}
1888
1889
	/**
1890
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1891
	 */
1892
	public static function is_user_connected( $user_id = false ) {
1893
		_deprecated_function( __METHOD__, 'jetpack-9.5', 'Automattic\\Jetpack\\Connection\\Manager\\is_user_connected' );
1894
		return self::connection()->is_user_connected( $user_id );
0 ignored issues
show
Documentation introduced by
$user_id is of type boolean, but the function expects a false|integer.

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...
1895
	}
1896
1897
	/**
1898
	 * Get the wpcom user data of the current|specified connected user.
1899
	 */
1900
	public static function get_connected_user_data( $user_id = null ) {
1901
		_deprecated_function( __METHOD__, 'jetpack-9.5', 'Automattic\\Jetpack\\Connection\\Manager\\get_connected_user_data' );
1902
		return self::connection()->get_connected_user_data( $user_id );
1903
	}
1904
1905
	/**
1906
	 * Get the wpcom email of the current|specified connected user.
1907
	 */
1908
	public static function get_connected_user_email( $user_id = null ) {
1909
		if ( ! $user_id ) {
1910
			$user_id = get_current_user_id();
1911
		}
1912
1913
		$xml = new Jetpack_IXR_Client(
1914
			array(
1915
				'user_id' => $user_id,
1916
			)
1917
		);
1918
		$xml->query( 'wpcom.getUserEmail' );
1919
		if ( ! $xml->isError() ) {
1920
			return $xml->getResponse();
1921
		}
1922
		return false;
1923
	}
1924
1925
	/**
1926
	 * Get the wpcom email of the master user.
1927
	 */
1928
	public static function get_master_user_email() {
1929
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1930
		if ( $master_user_id ) {
1931
			return self::get_connected_user_email( $master_user_id );
1932
		}
1933
		return '';
1934
	}
1935
1936
	/**
1937
	 * Whether the current user is the connection owner.
1938
	 *
1939
	 * @deprecated since 7.7
1940
	 *
1941
	 * @return bool Whether the current user is the connection owner.
1942
	 */
1943
	public function current_user_is_connection_owner() {
1944
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1945
		return self::connection()->is_connection_owner();
1946
	}
1947
1948
	/**
1949
	 * Gets current user IP address.
1950
	 *
1951
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1952
	 *
1953
	 * @return string                  Current user IP address.
1954
	 */
1955
	public static function current_user_ip( $check_all_headers = false ) {
1956
		if ( $check_all_headers ) {
1957
			foreach ( array(
1958
				'HTTP_CF_CONNECTING_IP',
1959
				'HTTP_CLIENT_IP',
1960
				'HTTP_X_FORWARDED_FOR',
1961
				'HTTP_X_FORWARDED',
1962
				'HTTP_X_CLUSTER_CLIENT_IP',
1963
				'HTTP_FORWARDED_FOR',
1964
				'HTTP_FORWARDED',
1965
				'HTTP_VIA',
1966
			) as $key ) {
1967
				if ( ! empty( $_SERVER[ $key ] ) ) {
1968
					return $_SERVER[ $key ];
1969
				}
1970
			}
1971
		}
1972
1973
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1974
	}
1975
1976
	/**
1977
	 * Synchronize connected user role changes
1978
	 */
1979
	function user_role_change( $user_id ) {
1980
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1981
		Users::user_role_change( $user_id );
1982
	}
1983
1984
	/**
1985
	 * Loads the currently active modules.
1986
	 */
1987
	public static function load_modules() {
1988
		$is_offline_mode = ( new Status() )->is_offline_mode();
1989
		if (
1990
			! self::is_connection_ready()
1991
			&& ! $is_offline_mode
1992
			&& ! self::is_onboarding()
1993
			&& (
1994
				! is_multisite()
1995
				|| ! get_site_option( 'jetpack_protect_active' )
1996
			)
1997
		) {
1998
			return;
1999
		}
2000
2001
		$version = Jetpack_Options::get_option( 'version' );
2002 View Code Duplication
		if ( ! $version ) {
2003
			$version = $old_version = JETPACK__VERSION . ':' . time();
2004
			/** This action is documented in class.jetpack.php */
2005
			do_action( 'updating_jetpack_version', $version, false );
2006
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2007
		}
2008
		list( $version ) = explode( ':', $version );
2009
2010
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
2011
2012
		$modules_data = array();
2013
2014
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
2015
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
2016
			$updated_modules = array();
2017
			foreach ( $modules as $module ) {
2018
				$modules_data[ $module ] = self::get_module( $module );
2019
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
2020
					continue;
2021
				}
2022
2023
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
2024
					continue;
2025
				}
2026
2027
				$updated_modules[] = $module;
2028
			}
2029
2030
			$modules = array_diff( $modules, $updated_modules );
2031
		}
2032
2033
		foreach ( $modules as $index => $module ) {
2034
			// If we're in offline mode, disable modules requiring a connection.
2035
			if ( $is_offline_mode ) {
2036
				// Prime the pump if we need to
2037
				if ( empty( $modules_data[ $module ] ) ) {
2038
					$modules_data[ $module ] = self::get_module( $module );
2039
				}
2040
				// If the module requires a connection, but we're in local mode, don't include it.
2041
				if ( $modules_data[ $module ]['requires_connection'] ) {
2042
					continue;
2043
				}
2044
			}
2045
2046
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
2047
				continue;
2048
			}
2049
2050
			if ( ! include_once self::get_module_path( $module ) ) {
2051
				unset( $modules[ $index ] );
2052
				self::update_active_modules( array_values( $modules ) );
2053
				continue;
2054
			}
2055
2056
			/**
2057
			 * Fires when a specific module is loaded.
2058
			 * The dynamic part of the hook, $module, is the module slug.
2059
			 *
2060
			 * @since 1.1.0
2061
			 */
2062
			do_action( 'jetpack_module_loaded_' . $module );
2063
		}
2064
2065
		/**
2066
		 * Fires when all the modules are loaded.
2067
		 *
2068
		 * @since 1.1.0
2069
		 */
2070
		do_action( 'jetpack_modules_loaded' );
2071
2072
		// 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.
2073
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
2074
	}
2075
2076
	/**
2077
	 * Check if Jetpack's REST API compat file should be included
2078
	 *
2079
	 * @action plugins_loaded
2080
	 * @return null
2081
	 */
2082
	public function check_rest_api_compat() {
2083
		/**
2084
		 * Filters the list of REST API compat files to be included.
2085
		 *
2086
		 * @since 2.2.5
2087
		 *
2088
		 * @param array $args Array of REST API compat files to include.
2089
		 */
2090
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
2091
2092
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
2093
			require_once $_jetpack_rest_api_compat_include;
2094
		}
2095
	}
2096
2097
	/**
2098
	 * Gets all plugins currently active in values, regardless of whether they're
2099
	 * traditionally activated or network activated.
2100
	 *
2101
	 * @todo Store the result in core's object cache maybe?
2102
	 */
2103
	public static function get_active_plugins() {
2104
		$active_plugins = (array) get_option( 'active_plugins', array() );
2105
2106
		if ( is_multisite() ) {
2107
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2108
			// whereas active_plugins stores them in the values.
2109
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2110
			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...
2111
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2112
			}
2113
		}
2114
2115
		sort( $active_plugins );
2116
2117
		return array_unique( $active_plugins );
2118
	}
2119
2120
	/**
2121
	 * Gets and parses additional plugin data to send with the heartbeat data
2122
	 *
2123
	 * @since 3.8.1
2124
	 *
2125
	 * @return array Array of plugin data
2126
	 */
2127
	public static function get_parsed_plugin_data() {
2128
		if ( ! function_exists( 'get_plugins' ) ) {
2129
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2130
		}
2131
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2132
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2133
		$active_plugins = self::get_active_plugins();
2134
2135
		$plugins = array();
2136
		foreach ( $all_plugins as $path => $plugin_data ) {
2137
			$plugins[ $path ] = array(
2138
				'is_active' => in_array( $path, $active_plugins ),
2139
				'file'      => $path,
2140
				'name'      => $plugin_data['Name'],
2141
				'version'   => $plugin_data['Version'],
2142
				'author'    => $plugin_data['Author'],
2143
			);
2144
		}
2145
2146
		return $plugins;
2147
	}
2148
2149
	/**
2150
	 * Gets and parses theme data to send with the heartbeat data
2151
	 *
2152
	 * @since 3.8.1
2153
	 *
2154
	 * @return array Array of theme data
2155
	 */
2156
	public static function get_parsed_theme_data() {
2157
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2158
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2159
2160
		$themes = array();
2161
		foreach ( $all_themes as $slug => $theme_data ) {
2162
			$theme_headers = array();
2163
			foreach ( $header_keys as $header_key ) {
2164
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2165
			}
2166
2167
			$themes[ $slug ] = array(
2168
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2169
				'slug'            => $slug,
2170
				'theme_root'      => $theme_data->get_theme_root_uri(),
2171
				'parent'          => $theme_data->parent(),
2172
				'headers'         => $theme_headers,
2173
			);
2174
		}
2175
2176
		return $themes;
2177
	}
2178
2179
	/**
2180
	 * Checks whether a specific plugin is active.
2181
	 *
2182
	 * We don't want to store these in a static variable, in case
2183
	 * there are switch_to_blog() calls involved.
2184
	 */
2185
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2186
		return in_array( $plugin, self::get_active_plugins() );
2187
	}
2188
2189
	/**
2190
	 * Check if Jetpack's Open Graph tags should be used.
2191
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2192
	 *
2193
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2194
	 * @action plugins_loaded
2195
	 * @return null
2196
	 */
2197
	public function check_open_graph() {
2198
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2199
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2200
		}
2201
2202
		$active_plugins = self::get_active_plugins();
2203
2204
		if ( ! empty( $active_plugins ) ) {
2205
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2206
				if ( in_array( $plugin, $active_plugins ) ) {
2207
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2208
					break;
2209
				}
2210
			}
2211
		}
2212
2213
		/**
2214
		 * Allow the addition of Open Graph Meta Tags to all pages.
2215
		 *
2216
		 * @since 2.0.3
2217
		 *
2218
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2219
		 */
2220
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2221
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2222
		}
2223
	}
2224
2225
	/**
2226
	 * Check if Jetpack's Twitter tags should be used.
2227
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2228
	 *
2229
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2230
	 * @action plugins_loaded
2231
	 * @return null
2232
	 */
2233
	public function check_twitter_tags() {
2234
2235
		$active_plugins = self::get_active_plugins();
2236
2237
		if ( ! empty( $active_plugins ) ) {
2238
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2239
				if ( in_array( $plugin, $active_plugins ) ) {
2240
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2241
					break;
2242
				}
2243
			}
2244
		}
2245
2246
		/**
2247
		 * Allow Twitter Card Meta tags to be disabled.
2248
		 *
2249
		 * @since 2.6.0
2250
		 *
2251
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2252
		 */
2253
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2254
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2255
		}
2256
	}
2257
2258
	/**
2259
	 * Allows plugins to submit security reports.
2260
	 *
2261
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2262
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2263
	 * @param array  $args         See definitions above
2264
	 */
2265
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2266
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2267
	}
2268
2269
	/* Jetpack Options API */
2270
2271
	public static function get_option_names( $type = 'compact' ) {
2272
		return Jetpack_Options::get_option_names( $type );
2273
	}
2274
2275
	/**
2276
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2277
	 *
2278
	 * @param string $name    Option name
2279
	 * @param mixed  $default (optional)
2280
	 */
2281
	public static function get_option( $name, $default = false ) {
2282
		return Jetpack_Options::get_option( $name, $default );
2283
	}
2284
2285
	/**
2286
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2287
	 *
2288
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2289
	 * @param string $name  Option name
2290
	 * @param mixed  $value Option value
2291
	 */
2292
	public static function update_option( $name, $value ) {
2293
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2294
		return Jetpack_Options::update_option( $name, $value );
2295
	}
2296
2297
	/**
2298
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2299
	 *
2300
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2301
	 * @param array $array array( option name => option value, ... )
2302
	 */
2303
	public static function update_options( $array ) {
2304
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2305
		return Jetpack_Options::update_options( $array );
2306
	}
2307
2308
	/**
2309
	 * Deletes the given option.  May be passed multiple option names as an array.
2310
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2311
	 *
2312
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2313
	 * @param string|array $names
2314
	 */
2315
	public static function delete_option( $names ) {
2316
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2317
		return Jetpack_Options::delete_option( $names );
2318
	}
2319
2320
	/**
2321
	 * Enters a user token into the user_tokens option
2322
	 *
2323
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Tokens->update_user_token() instead.
2324
	 *
2325
	 * @param int    $user_id The user id.
2326
	 * @param string $token The user token.
2327
	 * @param bool   $is_master_user Whether the user is the master user.
2328
	 * @return bool
2329
	 */
2330
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2331
		_deprecated_function( __METHOD__, 'jetpack-9.5', 'Automattic\\Jetpack\\Connection\\Tokens->update_user_token' );
2332
		return ( new Tokens() )->update_user_token( $user_id, $token, $is_master_user );
2333
	}
2334
2335
	/**
2336
	 * Returns an array of all PHP files in the specified absolute path.
2337
	 * Equivalent to glob( "$absolute_path/*.php" ).
2338
	 *
2339
	 * @param string $absolute_path The absolute path of the directory to search.
2340
	 * @return array Array of absolute paths to the PHP files.
2341
	 */
2342
	public static function glob_php( $absolute_path ) {
2343
		if ( function_exists( 'glob' ) ) {
2344
			return glob( "$absolute_path/*.php" );
2345
		}
2346
2347
		$absolute_path = untrailingslashit( $absolute_path );
2348
		$files         = array();
2349
		if ( ! $dir = @opendir( $absolute_path ) ) {
2350
			return $files;
2351
		}
2352
2353
		while ( false !== $file = readdir( $dir ) ) {
2354
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2355
				continue;
2356
			}
2357
2358
			$file = "$absolute_path/$file";
2359
2360
			if ( ! is_file( $file ) ) {
2361
				continue;
2362
			}
2363
2364
			$files[] = $file;
2365
		}
2366
2367
		closedir( $dir );
2368
2369
		return $files;
2370
	}
2371
2372
	public static function activate_new_modules( $redirect = false ) {
2373
		if ( ! self::is_connection_ready() && ! ( new Status() )->is_offline_mode() ) {
2374
			return;
2375
		}
2376
2377
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2378 View Code Duplication
		if ( ! $jetpack_old_version ) {
2379
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2380
			/** This action is documented in class.jetpack.php */
2381
			do_action( 'updating_jetpack_version', $version, false );
2382
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2383
		}
2384
2385
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2386
2387
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2388
			return;
2389
		}
2390
2391
		$active_modules     = self::get_active_modules();
2392
		$reactivate_modules = array();
2393
		foreach ( $active_modules as $active_module ) {
2394
			$module = self::get_module( $active_module );
2395
			if ( ! isset( $module['changed'] ) ) {
2396
				continue;
2397
			}
2398
2399
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2400
				continue;
2401
			}
2402
2403
			$reactivate_modules[] = $active_module;
2404
			self::deactivate_module( $active_module );
2405
		}
2406
2407
		$new_version = JETPACK__VERSION . ':' . time();
2408
		/** This action is documented in class.jetpack.php */
2409
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2410
		Jetpack_Options::update_options(
2411
			array(
2412
				'version'     => $new_version,
2413
				'old_version' => $jetpack_old_version,
2414
			)
2415
		);
2416
2417
		self::state( 'message', 'modules_activated' );
2418
2419
		self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2420
2421
		if ( $redirect ) {
2422
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2423
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2424
				$page = $_GET['page'];
2425
			}
2426
2427
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2428
			exit;
2429
		}
2430
	}
2431
2432
	/**
2433
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2434
	 * Make sure to tuck away module "library" files in a sub-directory.
2435
	 *
2436
	 * @param bool|string $min_version Only return modules introduced in this version or later. Default is false, do not filter.
2437
	 * @param bool|string $max_version Only return modules introduced before this version. Default is false, do not filter.
2438
	 * @param bool|null   $requires_connection Pass a boolean value to only return modules that require (or do not require) a connection.
2439
	 * @param bool|null   $requires_user_connection Pass a boolean value to only return modules that require (or do not require) a user connection.
2440
	 *
2441
	 * @return array $modules Array of module slugs
2442
	 */
2443
	public static function get_available_modules( $min_version = false, $max_version = false, $requires_connection = null, $requires_user_connection = null ) {
2444
		static $modules = null;
2445
2446
		if ( ! isset( $modules ) ) {
2447
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2448
			// Use the cache if we're on the front-end and it's available...
2449
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2450
				$modules = $available_modules_option[ JETPACK__VERSION ];
2451
			} else {
2452
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2453
2454
				$modules = array();
2455
2456
				foreach ( $files as $file ) {
2457
					if ( ! $headers = self::get_module( $file ) ) {
2458
						continue;
2459
					}
2460
2461
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2462
				}
2463
2464
				Jetpack_Options::update_option(
2465
					'available_modules',
2466
					array(
2467
						JETPACK__VERSION => $modules,
2468
					)
2469
				);
2470
			}
2471
		}
2472
2473
		/**
2474
		 * Filters the array of modules available to be activated.
2475
		 *
2476
		 * @since 2.4.0
2477
		 *
2478
		 * @param array $modules Array of available modules.
2479
		 * @param string $min_version Minimum version number required to use modules.
2480
		 * @param string $max_version Maximum version number required to use modules.
2481
		 * @param bool|null $requires_connection Value of the Requires Connection filter.
2482
		 * @param bool|null $requires_user_connection Value of the Requires User Connection filter.
2483
		 */
2484
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version, $requires_connection, $requires_user_connection );
0 ignored issues
show
Unused Code introduced by
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...
2485
2486
		if ( ! $min_version && ! $max_version && is_null( $requires_connection ) && is_null( $requires_user_connection ) ) {
2487
			return array_keys( $mods );
2488
		}
2489
2490
		$r = array();
2491
		foreach ( $mods as $slug => $introduced ) {
2492
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2493
				continue;
2494
			}
2495
2496
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2497
				continue;
2498
			}
2499
2500
			$mod_details = self::get_module( $slug );
2501
2502
			if ( null !== $requires_connection && (bool) $requires_connection !== $mod_details['requires_connection'] ) {
2503
				continue;
2504
			}
2505
2506
			if ( null !== $requires_user_connection && (bool) $requires_user_connection !== $mod_details['requires_user_connection'] ) {
2507
				continue;
2508
			}
2509
2510
			$r[] = $slug;
2511
		}
2512
2513
		return $r;
2514
	}
2515
2516
	/**
2517
	 * Get default modules loaded on activation.
2518
	 *
2519
	 * @param bool|string $min_version Onlu return modules introduced in this version or later. Default is false, do not filter.
2520
	 * @param bool|string $max_version Only return modules introduced before this version. Default is false, do not filter.
2521
	 * @param bool|null   $requires_connection Pass a boolean value to only return modules that require (or do not require) a connection.
2522
	 * @param bool|null   $requires_user_connection Pass a boolean value to only return modules that require (or do not require) a user connection.
2523
	 *
2524
	 * @return array $modules Array of module slugs
2525
	 */
2526
	public static function get_default_modules( $min_version = false, $max_version = false, $requires_connection = null, $requires_user_connection = null ) {
2527
		$return = array();
2528
2529
		foreach ( self::get_available_modules( $min_version, $max_version, $requires_connection, $requires_user_connection ) as $module ) {
2530
			$module_data = self::get_module( $module );
2531
2532
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2533
				case 'yes':
2534
					$return[] = $module;
2535
					break;
2536
				case 'public':
2537
					if ( Jetpack_Options::get_option( 'public' ) ) {
2538
						$return[] = $module;
2539
					}
2540
					break;
2541
				case 'no':
2542
				default:
2543
					break;
2544
			}
2545
		}
2546
		/**
2547
		 * Filters the array of default modules.
2548
		 *
2549
		 * @since 2.5.0
2550
		 *
2551
		 * @param array $return Array of default modules.
2552
		 * @param string $min_version Minimum version number required to use modules.
2553
		 * @param string $max_version Maximum version number required to use modules.
2554
		 * @param bool|null $requires_connection Value of the Requires Connection filter.
2555
		 * @param bool|null $requires_user_connection Value of the Requires User Connection filter.
2556
		 */
2557
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version, $requires_connection, $requires_user_connection );
0 ignored issues
show
Unused Code introduced by
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...
2558
	}
2559
2560
	/**
2561
	 * Checks activated modules during auto-activation to determine
2562
	 * if any of those modules are being deprecated.  If so, close
2563
	 * them out, and add any replacement modules.
2564
	 *
2565
	 * Runs at priority 99 by default.
2566
	 *
2567
	 * This is run late, so that it can still activate a module if
2568
	 * the new module is a replacement for another that the user
2569
	 * currently has active, even if something at the normal priority
2570
	 * would kibosh everything.
2571
	 *
2572
	 * @since 2.6
2573
	 * @uses jetpack_get_default_modules filter
2574
	 * @param array $modules
2575
	 * @return array
2576
	 */
2577
	function handle_deprecated_modules( $modules ) {
2578
		$deprecated_modules = array(
2579
			'debug'            => null,  // Closed out and moved to the debugger library.
2580
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2581
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2582
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2583
		);
2584
2585
		// Don't activate SSO if they never completed activating WPCC.
2586
		if ( self::is_module_active( 'wpcc' ) ) {
2587
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2588
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2589
				$deprecated_modules['wpcc'] = null;
2590
			}
2591
		}
2592
2593
		foreach ( $deprecated_modules as $module => $replacement ) {
2594
			if ( self::is_module_active( $module ) ) {
2595
				self::deactivate_module( $module );
2596
				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...
2597
					$modules[] = $replacement;
2598
				}
2599
			}
2600
		}
2601
2602
		return array_unique( $modules );
2603
	}
2604
2605
	/**
2606
	 * Checks activated plugins during auto-activation to determine
2607
	 * if any of those plugins are in the list with a corresponding module
2608
	 * that is not compatible with the plugin. The module will not be allowed
2609
	 * to auto-activate.
2610
	 *
2611
	 * @since 2.6
2612
	 * @uses jetpack_get_default_modules filter
2613
	 * @param array $modules
2614
	 * @return array
2615
	 */
2616
	function filter_default_modules( $modules ) {
2617
2618
		$active_plugins = self::get_active_plugins();
2619
2620
		if ( ! empty( $active_plugins ) ) {
2621
2622
			// For each module we'd like to auto-activate...
2623
			foreach ( $modules as $key => $module ) {
2624
				// If there are potential conflicts for it...
2625
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2626
					// For each potential conflict...
2627
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2628
						// If that conflicting plugin is active...
2629
						if ( in_array( $plugin, $active_plugins ) ) {
2630
							// Remove that item from being auto-activated.
2631
							unset( $modules[ $key ] );
2632
						}
2633
					}
2634
				}
2635
			}
2636
		}
2637
2638
		return $modules;
2639
	}
2640
2641
	/**
2642
	 * Extract a module's slug from its full path.
2643
	 */
2644
	public static function get_module_slug( $file ) {
2645
		return str_replace( '.php', '', basename( $file ) );
2646
	}
2647
2648
	/**
2649
	 * Generate a module's path from its slug.
2650
	 */
2651
	public static function get_module_path( $slug ) {
2652
		/**
2653
		 * Filters the path of a modules.
2654
		 *
2655
		 * @since 7.4.0
2656
		 *
2657
		 * @param array $return The absolute path to a module's root php file
2658
		 * @param string $slug The module slug
2659
		 */
2660
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
0 ignored issues
show
Unused Code introduced by
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...
2661
	}
2662
2663
	/**
2664
	 * Load module data from module file. Headers differ from WordPress
2665
	 * plugin headers to avoid them being identified as standalone
2666
	 * plugins on the WordPress plugins page.
2667
	 */
2668
	public static function get_module( $module ) {
2669
		$headers = array(
2670
			'name'                      => 'Module Name',
2671
			'description'               => 'Module Description',
2672
			'sort'                      => 'Sort Order',
2673
			'recommendation_order'      => 'Recommendation Order',
2674
			'introduced'                => 'First Introduced',
2675
			'changed'                   => 'Major Changes In',
2676
			'deactivate'                => 'Deactivate',
2677
			'free'                      => 'Free',
2678
			'requires_connection'       => 'Requires Connection',
2679
			'requires_user_connection'  => 'Requires User Connection',
2680
			'auto_activate'             => 'Auto Activate',
2681
			'module_tags'               => 'Module Tags',
2682
			'feature'                   => 'Feature',
2683
			'additional_search_queries' => 'Additional Search Queries',
2684
			'plan_classes'              => 'Plans',
2685
		);
2686
2687
		static $modules_details;
2688
		$file = self::get_module_path( self::get_module_slug( $module ) );
2689
2690
		if ( isset( $modules_details[ $module ] ) ) {
2691
			$mod = $modules_details[ $module ];
2692
		} else {
2693
2694
			$mod = self::get_file_data( $file, $headers );
2695
			if ( empty( $mod['name'] ) ) {
2696
				return false;
2697
			}
2698
2699
			$mod['sort']                     = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2700
			$mod['recommendation_order']     = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2701
			$mod['deactivate']               = empty( $mod['deactivate'] );
2702
			$mod['free']                     = empty( $mod['free'] );
2703
			$mod['requires_connection']      = ( ! empty( $mod['requires_connection'] ) && 'No' === $mod['requires_connection'] ) ? false : true;
2704
			$mod['requires_user_connection'] = ( empty( $mod['requires_user_connection'] ) || 'No' === $mod['requires_user_connection'] ) ? false : true;
2705
2706
			if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ), true ) ) {
2707
				$mod['auto_activate'] = 'No';
2708
			} else {
2709
				$mod['auto_activate'] = (string) $mod['auto_activate'];
2710
			}
2711
2712
			if ( $mod['module_tags'] ) {
2713
				$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2714
				$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2715
				$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2716
			} else {
2717
				$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2718
			}
2719
2720 View Code Duplication
			if ( $mod['plan_classes'] ) {
2721
				$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2722
				$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2723
			} else {
2724
				$mod['plan_classes'] = array( 'free' );
2725
			}
2726
2727 View Code Duplication
			if ( $mod['feature'] ) {
2728
				$mod['feature'] = explode( ',', $mod['feature'] );
2729
				$mod['feature'] = array_map( 'trim', $mod['feature'] );
2730
			} else {
2731
				$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2732
			}
2733
2734
			$modules_details[ $module ] = $mod;
2735
2736
		}
2737
2738
		/**
2739
		 * Filters the feature array on a module.
2740
		 *
2741
		 * This filter allows you to control where each module is filtered: Recommended,
2742
		 * and the default "Other" listing.
2743
		 *
2744
		 * @since 3.5.0
2745
		 *
2746
		 * @param array   $mod['feature'] The areas to feature this module:
2747
		 *     'Recommended' shows on the main Jetpack admin screen.
2748
		 *     'Other' should be the default if no other value is in the array.
2749
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2750
		 * @param array   $mod All the currently assembled module data.
2751
		 */
2752
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
0 ignored issues
show
Unused Code introduced by
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...
2753
2754
		/**
2755
		 * Filter the returned data about a module.
2756
		 *
2757
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2758
		 * so please be careful.
2759
		 *
2760
		 * @since 3.6.0
2761
		 *
2762
		 * @param array   $mod    The details of the requested module.
2763
		 * @param string  $module The slug of the module, e.g. sharedaddy
2764
		 * @param string  $file   The path to the module source file.
2765
		 */
2766
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
0 ignored issues
show
Unused Code introduced by
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...
2767
	}
2768
2769
	/**
2770
	 * Like core's get_file_data implementation, but caches the result.
2771
	 */
2772
	public static function get_file_data( $file, $headers ) {
2773
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2774
		$file_name = basename( $file );
2775
2776
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2777
2778
		$file_data_option = get_transient( $cache_key );
2779
2780
		if ( ! is_array( $file_data_option ) ) {
2781
			delete_transient( $cache_key );
2782
			$file_data_option = false;
2783
		}
2784
2785
		if ( false === $file_data_option ) {
2786
			$file_data_option = array();
2787
		}
2788
2789
		$key           = md5( $file_name . serialize( $headers ) );
2790
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2791
2792
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2793
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2794
			return $file_data_option[ $key ];
2795
		}
2796
2797
		$data = get_file_data( $file, $headers );
2798
2799
		$file_data_option[ $key ] = $data;
2800
2801
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2802
2803
		return $data;
2804
	}
2805
2806
	/**
2807
	 * Return translated module tag.
2808
	 *
2809
	 * @param string $tag Tag as it appears in each module heading.
2810
	 *
2811
	 * @return mixed
2812
	 */
2813
	public static function translate_module_tag( $tag ) {
2814
		return jetpack_get_module_i18n_tag( $tag );
2815
	}
2816
2817
	/**
2818
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2819
	 *
2820
	 * @since 3.9.2
2821
	 *
2822
	 * @param array $modules
2823
	 *
2824
	 * @return string|void
2825
	 */
2826
	public static function get_translated_modules( $modules ) {
2827
		foreach ( $modules as $index => $module ) {
2828
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2829
			if ( isset( $module['name'] ) ) {
2830
				$modules[ $index ]['name'] = $i18n_module['name'];
2831
			}
2832
			if ( isset( $module['description'] ) ) {
2833
				$modules[ $index ]['description']       = $i18n_module['description'];
2834
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2835
			}
2836
		}
2837
		return $modules;
2838
	}
2839
2840
	/**
2841
	 * Get a list of activated modules as an array of module slugs.
2842
	 */
2843
	public static function get_active_modules() {
2844
		$active = Jetpack_Options::get_option( 'active_modules' );
2845
2846
		if ( ! is_array( $active ) ) {
2847
			$active = array();
2848
		}
2849
2850
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2851
			$active[] = 'vaultpress';
2852
		} else {
2853
			$active = array_diff( $active, array( 'vaultpress' ) );
2854
		}
2855
2856
		// If protect is active on the main site of a multisite, it should be active on all sites.
2857
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2858
			$active[] = 'protect';
2859
		}
2860
2861
		/**
2862
		 * Allow filtering of the active modules.
2863
		 *
2864
		 * Gives theme and plugin developers the power to alter the modules that
2865
		 * are activated on the fly.
2866
		 *
2867
		 * @since 5.8.0
2868
		 *
2869
		 * @param array $active Array of active module slugs.
2870
		 */
2871
		$active = apply_filters( 'jetpack_active_modules', $active );
2872
2873
		return array_unique( $active );
2874
	}
2875
2876
	/**
2877
	 * Check whether or not a Jetpack module is active.
2878
	 *
2879
	 * @param string $module The slug of a Jetpack module.
2880
	 * @return bool
2881
	 *
2882
	 * @static
2883
	 */
2884
	public static function is_module_active( $module ) {
2885
		return in_array( $module, self::get_active_modules() );
2886
	}
2887
2888
	public static function is_module( $module ) {
2889
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2890
	}
2891
2892
	/**
2893
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2894
	 *
2895
	 * @param bool $catch True to start catching, False to stop.
2896
	 *
2897
	 * @static
2898
	 */
2899
	public static function catch_errors( $catch ) {
2900
		static $display_errors, $error_reporting;
2901
2902
		if ( $catch ) {
2903
			$display_errors  = @ini_set( 'display_errors', 1 );
2904
			$error_reporting = @error_reporting( E_ALL );
2905
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2906
		} else {
2907
			@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...
2908
			@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...
2909
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2910
		}
2911
	}
2912
2913
	/**
2914
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2915
	 */
2916
	public static function catch_errors_on_shutdown() {
2917
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2918
	}
2919
2920
	/**
2921
	 * Rewrite any string to make paths easier to read.
2922
	 *
2923
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2924
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2925
	 *
2926
	 * @param $string
2927
	 * @return mixed
2928
	 */
2929
	public static function alias_directories( $string ) {
2930
		// ABSPATH has a trailing slash.
2931
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2932
		// WP_CONTENT_DIR does not have a trailing slash.
2933
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2934
2935
		return $string;
2936
	}
2937
2938
	public static function activate_default_modules(
2939
		$min_version = false,
2940
		$max_version = false,
2941
		$other_modules = array(),
2942
		$redirect = null,
2943
		$send_state_messages = null,
2944
		$requires_connection = null,
2945
		$requires_user_connection = null
2946
	) {
2947
		$jetpack = self::init();
2948
2949
		if ( is_null( $redirect ) ) {
2950
			if (
2951
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2952
			||
2953
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2954
			||
2955
				( defined( 'WP_CLI' ) && WP_CLI )
2956
			||
2957
				( defined( 'DOING_CRON' ) && DOING_CRON )
2958
			||
2959
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2960
			) {
2961
				$redirect = false;
2962
			} elseif ( is_admin() ) {
2963
				$redirect = true;
2964
			} else {
2965
				$redirect = false;
2966
			}
2967
		}
2968
2969
		if ( is_null( $send_state_messages ) ) {
2970
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2971
		}
2972
2973
		$modules = self::get_default_modules( $min_version, $max_version, $requires_connection, $requires_user_connection );
2974
		$modules = array_merge( $other_modules, $modules );
2975
2976
		// Look for standalone plugins and disable if active.
2977
2978
		$to_deactivate = array();
2979
		foreach ( $modules as $module ) {
2980
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2981
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2982
			}
2983
		}
2984
2985
		$deactivated = array();
2986
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2987
			list( $probable_file, $probable_title ) = $deactivate_me;
2988
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2989
				$deactivated[] = $module;
2990
			}
2991
		}
2992
2993
		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...
2994
			if ( $send_state_messages ) {
2995
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2996
			}
2997
2998
			if ( $redirect ) {
2999
				$url = add_query_arg(
3000
					array(
3001
						'action'   => 'activate_default_modules',
3002
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
3003
					),
3004
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
3005
				);
3006
				wp_safe_redirect( $url );
3007
				exit;
3008
			}
3009
		}
3010
3011
		/**
3012
		 * Fires before default modules are activated.
3013
		 *
3014
		 * @since 1.9.0
3015
		 *
3016
		 * @param string    $min_version Minimum version number required to use modules.
3017
		 * @param string    $max_version Maximum version number required to use modules.
3018
		 * @param array     $other_modules Array of other modules to activate alongside the default modules.
3019
		 * @param bool|null $requires_connection Value of the Requires Connection filter.
3020
		 * @param bool|null $requires_user_connection Value of the Requires User Connection filter.
3021
		 */
3022
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules, $requires_connection, $requires_user_connection );
3023
3024
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
3025
		if ( $send_state_messages ) {
3026
			self::restate();
3027
			self::catch_errors( true );
3028
		}
3029
3030
		$active = self::get_active_modules();
3031
3032
		foreach ( $modules as $module ) {
3033
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
3034
				$active[] = $module;
3035
				self::update_active_modules( $active );
3036
				continue;
3037
			}
3038
3039
			if ( $send_state_messages && in_array( $module, $active ) ) {
3040
				$module_info = self::get_module( $module );
3041 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
3042
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
3043
					if ( $active_state = self::state( $state ) ) {
3044
						$active_state = explode( ',', $active_state );
3045
					} else {
3046
						$active_state = array();
3047
					}
3048
					$active_state[] = $module;
3049
					self::state( $state, implode( ',', $active_state ) );
3050
				}
3051
				continue;
3052
			}
3053
3054
			$file = self::get_module_path( $module );
3055
			if ( ! file_exists( $file ) ) {
3056
				continue;
3057
			}
3058
3059
			// we'll override this later if the plugin can be included without fatal error
3060
			if ( $redirect ) {
3061
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3062
			}
3063
3064
			if ( $send_state_messages ) {
3065
				self::state( 'error', 'module_activation_failed' );
3066
				self::state( 'module', $module );
3067
			}
3068
3069
			ob_start();
3070
			require_once $file;
3071
3072
			$active[] = $module;
3073
3074 View Code Duplication
			if ( $send_state_messages ) {
3075
3076
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
3077
				if ( $active_state = self::state( $state ) ) {
3078
					$active_state = explode( ',', $active_state );
3079
				} else {
3080
					$active_state = array();
3081
				}
3082
				$active_state[] = $module;
3083
				self::state( $state, implode( ',', $active_state ) );
3084
			}
3085
3086
			self::update_active_modules( $active );
3087
3088
			ob_end_clean();
3089
		}
3090
3091
		if ( $send_state_messages ) {
3092
			self::state( 'error', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3093
			self::state( 'module', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3094
		}
3095
3096
		self::catch_errors( false );
3097
		/**
3098
		 * Fires when default modules are activated.
3099
		 *
3100
		 * @since 1.9.0
3101
		 *
3102
		 * @param string    $min_version Minimum version number required to use modules.
3103
		 * @param string    $max_version Maximum version number required to use modules.
3104
		 * @param array     $other_modules Array of other modules to activate alongside the default modules.
3105
		 * @param bool|null $requires_connection Value of the Requires Connection filter.
3106
		 * @param bool|null $requires_user_connection Value of the Requires User Connection filter.
3107
		 */
3108
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules, $requires_connection, $requires_user_connection );
3109
	}
3110
3111
	public static function activate_module( $module, $exit = true, $redirect = true ) {
3112
		/**
3113
		 * Fires before a module is activated.
3114
		 *
3115
		 * @since 2.6.0
3116
		 *
3117
		 * @param string $module Module slug.
3118
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
3119
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
3120
		 */
3121
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
3122
3123
		$jetpack = self::init();
3124
3125
		if ( ! strlen( $module ) ) {
3126
			return false;
3127
		}
3128
3129
		if ( ! self::is_module( $module ) ) {
3130
			return false;
3131
		}
3132
3133
		// If it's already active, then don't do it again
3134
		$active = self::get_active_modules();
3135
		foreach ( $active as $act ) {
3136
			if ( $act == $module ) {
3137
				return true;
3138
			}
3139
		}
3140
3141
		$module_data = self::get_module( $module );
3142
3143
		$is_offline_mode = ( new Status() )->is_offline_mode();
3144
		if ( ! self::is_connection_ready() ) {
3145
			if ( ! $is_offline_mode && ! self::is_onboarding() ) {
3146
				return false;
3147
			}
3148
3149
			// If we're not connected but in offline mode, make sure the module doesn't require a connection.
3150
			if ( $is_offline_mode && $module_data['requires_connection'] ) {
3151
				return false;
3152
			}
3153
		}
3154
3155
		// Check and see if the old plugin is active
3156
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3157
			// Deactivate the old plugin
3158
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3159
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3160
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3161
				self::state( 'deactivated_plugins', $module );
3162
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3163
				exit;
3164
			}
3165
		}
3166
3167
		// Protect won't work with mis-configured IPs
3168
		if ( 'protect' === $module ) {
3169
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3170
			if ( ! jetpack_protect_get_ip() ) {
3171
				self::state( 'message', 'protect_misconfigured_ip' );
3172
				return false;
3173
			}
3174
		}
3175
3176
		if ( ! Jetpack_Plan::supports( $module ) ) {
3177
			return false;
3178
		}
3179
3180
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3181
		self::state( 'module', $module );
3182
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3183
3184
		self::catch_errors( true );
3185
		ob_start();
3186
		require self::get_module_path( $module );
3187
		/** This action is documented in class.jetpack.php */
3188
		do_action( 'jetpack_activate_module', $module );
3189
		$active[] = $module;
3190
		self::update_active_modules( $active );
3191
3192
		self::state( 'error', false ); // the override
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3193
		ob_end_clean();
3194
		self::catch_errors( false );
3195
3196
		if ( $redirect ) {
3197
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3198
		}
3199
		if ( $exit ) {
3200
			exit;
3201
		}
3202
		return true;
3203
	}
3204
3205
	function activate_module_actions( $module ) {
3206
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3207
	}
3208
3209
	public static function deactivate_module( $module ) {
3210
		/**
3211
		 * Fires when a module is deactivated.
3212
		 *
3213
		 * @since 1.9.0
3214
		 *
3215
		 * @param string $module Module slug.
3216
		 */
3217
		do_action( 'jetpack_pre_deactivate_module', $module );
3218
3219
		$jetpack = self::init();
0 ignored issues
show
Unused Code introduced by
$jetpack is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3220
3221
		$active = self::get_active_modules();
3222
		$new    = array_filter( array_diff( $active, (array) $module ) );
3223
3224
		return self::update_active_modules( $new );
3225
	}
3226
3227
	public static function enable_module_configurable( $module ) {
3228
		$module = self::get_module_slug( $module );
3229
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3230
	}
3231
3232
	/**
3233
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3234
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3235
	 *
3236
	 * @param string $module Module slug
3237
	 * @return string $url module configuration URL
3238
	 */
3239
	public static function module_configuration_url( $module ) {
3240
		$module      = self::get_module_slug( $module );
3241
		$default_url = self::admin_url() . "#/settings?term=$module";
3242
		/**
3243
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3244
		 *
3245
		 * @since 6.9.0
3246
		 *
3247
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3248
		 */
3249
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3250
3251
		return $url;
3252
	}
3253
3254
	/* Installation */
3255
	public static function bail_on_activation( $message, $deactivate = true ) {
3256
		?>
3257
<!doctype html>
3258
<html>
3259
<head>
3260
<meta charset="<?php bloginfo( 'charset' ); ?>">
3261
<style>
3262
* {
3263
	text-align: center;
3264
	margin: 0;
3265
	padding: 0;
3266
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3267
}
3268
p {
3269
	margin-top: 1em;
3270
	font-size: 18px;
3271
}
3272
</style>
3273
<body>
3274
<p><?php echo esc_html( $message ); ?></p>
3275
</body>
3276
</html>
3277
		<?php
3278
		if ( $deactivate ) {
3279
			$plugins = get_option( 'active_plugins' );
3280
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3281
			$update  = false;
3282
			foreach ( $plugins as $i => $plugin ) {
3283
				if ( $plugin === $jetpack ) {
3284
					$plugins[ $i ] = false;
3285
					$update        = true;
3286
				}
3287
			}
3288
3289
			if ( $update ) {
3290
				update_option( 'active_plugins', array_filter( $plugins ) );
3291
			}
3292
		}
3293
		exit;
3294
	}
3295
3296
	/**
3297
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3298
	 *
3299
	 * @static
3300
	 */
3301
	public static function plugin_activation( $network_wide ) {
3302
		Jetpack_Options::update_option( 'activated', 1 );
3303
3304
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3305
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3306
		}
3307
3308
		if ( $network_wide ) {
3309
			self::state( 'network_nag', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3310
		}
3311
3312
		// For firing one-off events (notices) immediately after activation
3313
		set_transient( 'activated_jetpack', true, 0.1 * MINUTE_IN_SECONDS );
3314
3315
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3316
3317
		Health::on_jetpack_activated();
3318
3319
		self::plugin_initialize();
3320
	}
3321
3322
	public static function get_activation_source( $referer_url ) {
3323
3324
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3325
			return array( 'wp-cli', null );
3326
		}
3327
3328
		$referer = wp_parse_url( $referer_url );
3329
3330
		$source_type  = 'unknown';
3331
		$source_query = null;
3332
3333
		if ( ! is_array( $referer ) ) {
3334
			return array( $source_type, $source_query );
3335
		}
3336
3337
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3338
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3339
3340
		if ( isset( $referer['query'] ) ) {
3341
			parse_str( $referer['query'], $query_parts );
3342
		} else {
3343
			$query_parts = array();
3344
		}
3345
3346
		if ( $plugins_path === $referer['path'] ) {
3347
			$source_type = 'list';
3348
		} elseif ( $plugins_install_path === $referer['path'] ) {
3349
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3350
			switch ( $tab ) {
3351
				case 'popular':
3352
					$source_type = 'popular';
3353
					break;
3354
				case 'recommended':
3355
					$source_type = 'recommended';
3356
					break;
3357
				case 'favorites':
3358
					$source_type = 'favorites';
3359
					break;
3360
				case 'search':
3361
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3362
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3363
					break;
3364
				default:
3365
					$source_type = 'featured';
3366
			}
3367
		}
3368
3369
		return array( $source_type, $source_query );
3370
	}
3371
3372
	/**
3373
	 * Runs before bumping version numbers up to a new version
3374
	 *
3375
	 * @param string $version    Version:timestamp.
3376
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3377
	 */
3378
	public static function do_version_bump( $version, $old_version ) {
3379
		if ( $old_version ) { // For existing Jetpack installations.
3380
3381
			// If a front end page is visited after the update, the 'wp' action will fire.
3382
			add_action( 'wp', 'Jetpack::set_update_modal_display' );
3383
3384
			// If an admin page is visited after the update, the 'current_screen' action will fire.
3385
			add_action( 'current_screen', 'Jetpack::set_update_modal_display' );
3386
		}
3387
	}
3388
3389
	/**
3390
	 * Sets the display_update_modal state.
3391
	 */
3392
	public static function set_update_modal_display() {
3393
		self::state( 'display_update_modal', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3394
	}
3395
3396
	/**
3397
	 * Sets the internal version number and activation state.
3398
	 *
3399
	 * @static
3400
	 */
3401
	public static function plugin_initialize() {
3402
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3403
			Jetpack_Options::update_option( 'activated', 2 );
3404
		}
3405
3406 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3407
			$version = $old_version = JETPACK__VERSION . ':' . time();
3408
			/** This action is documented in class.jetpack.php */
3409
			do_action( 'updating_jetpack_version', $version, false );
3410
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3411
		}
3412
3413
		self::load_modules();
3414
3415
		Jetpack_Options::delete_option( 'do_activate' );
3416
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3417
	}
3418
3419
	/**
3420
	 * Removes all connection options
3421
	 *
3422
	 * @static
3423
	 */
3424
	public static function plugin_deactivation() {
3425
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3426
		$tracking = new Tracking();
3427
		$tracking->record_user_event( 'deactivate_plugin', array() );
3428
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3429
			Jetpack_Network::init()->deactivate();
3430
		} else {
3431
			self::disconnect( false );
3432
			// Jetpack_Heartbeat::init()->deactivate();
3433
		}
3434
	}
3435
3436
	/**
3437
	 * Disconnects from the Jetpack servers.
3438
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3439
	 *
3440
	 * @static
3441
	 */
3442
	public static function disconnect( $update_activated_state = true ) {
3443
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3444
3445
		$connection = self::connection();
3446
3447
		( new Nonce_Handler() )->clean_all();
3448
3449
		// If the site is in an IDC because sync is not allowed,
3450
		// let's make sure to not disconnect the production site.
3451
		if ( ! self::validate_sync_error_idc_option() ) {
3452
			$tracking = new Tracking();
3453
			$tracking->record_user_event( 'disconnect_site', array() );
3454
3455
			$connection->disconnect_site_wpcom( true );
3456
		}
3457
3458
		$connection->delete_all_connection_tokens( true );
3459
		Jetpack_IDC::clear_all_idc_options();
3460
3461
		if ( $update_activated_state ) {
3462
			Jetpack_Options::update_option( 'activated', 4 );
3463
		}
3464
3465
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3466
			// Check then record unique disconnection if site has never been disconnected previously
3467
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3468
				$jetpack_unique_connection['disconnected'] = 1;
3469
			} else {
3470
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3471
					// track unique disconnect
3472
					$jetpack = self::init();
3473
3474
					$jetpack->stat( 'connections', 'unique-disconnect' );
3475
					$jetpack->do_stats( 'server_side' );
3476
				}
3477
				// increment number of times disconnected
3478
				$jetpack_unique_connection['disconnected'] += 1;
3479
			}
3480
3481
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3482
		}
3483
3484
		// Delete all the sync related data. Since it could be taking up space.
3485
		Sender::get_instance()->uninstall();
3486
3487
	}
3488
3489
	/**
3490
	 * Disconnects the user
3491
	 *
3492
	 * @param int $user_id The user ID to disconnect.
3493
	 */
3494
	public function disconnect_user( $user_id ) {
3495
		$this->connection_manager->disconnect_user( $user_id );
3496
	}
3497
3498
	/**
3499
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3500
	 */
3501
	public static function try_registration() {
3502
		$terms_of_service = new Terms_Of_Service();
3503
		// The user has agreed to the TOS at some point by now.
3504
		$terms_of_service->agree();
3505
3506
		// Let's get some testing in beta versions and such.
3507
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3508
			// Before attempting to connect, let's make sure that the domains are viable.
3509
			$domains_to_check = array_unique(
3510
				array(
3511
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3512
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3513
				)
3514
			);
3515
			foreach ( $domains_to_check as $domain ) {
3516
				$result = self::connection()->is_usable_domain( $domain );
0 ignored issues
show
Security Bug introduced by
It seems like $domain defined by $domain on line 3515 can also be of type false; however, Automattic\Jetpack\Conne...ger::is_usable_domain() does only seem to accept string, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
3517
				if ( is_wp_error( $result ) ) {
3518
					return $result;
3519
				}
3520
			}
3521
		}
3522
3523
		$result = self::register();
3524
3525
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3526
		if ( ! $result || is_wp_error( $result ) ) {
3527
			return $result;
3528
		} else {
3529
			return true;
3530
		}
3531
	}
3532
3533
	/**
3534
	 * Tracking an internal event log. Try not to put too much chaff in here.
3535
	 *
3536
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3537
	 */
3538
	public static function log( $code, $data = null ) {
3539
		// only grab the latest 200 entries
3540
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3541
3542
		// Append our event to the log
3543
		$log_entry = array(
3544
			'time'    => time(),
3545
			'user_id' => get_current_user_id(),
3546
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3547
			'code'    => $code,
3548
		);
3549
		// Don't bother storing it unless we've got some.
3550
		if ( ! is_null( $data ) ) {
3551
			$log_entry['data'] = $data;
3552
		}
3553
		$log[] = $log_entry;
3554
3555
		// Try add_option first, to make sure it's not autoloaded.
3556
		// @todo: Add an add_option method to Jetpack_Options
3557
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3558
			Jetpack_Options::update_option( 'log', $log );
3559
		}
3560
3561
		/**
3562
		 * Fires when Jetpack logs an internal event.
3563
		 *
3564
		 * @since 3.0.0
3565
		 *
3566
		 * @param array $log_entry {
3567
		 *  Array of details about the log entry.
3568
		 *
3569
		 *  @param string time Time of the event.
3570
		 *  @param int user_id ID of the user who trigerred the event.
3571
		 *  @param int blog_id Jetpack Blog ID.
3572
		 *  @param string code Unique name for the event.
3573
		 *  @param string data Data about the event.
3574
		 * }
3575
		 */
3576
		do_action( 'jetpack_log_entry', $log_entry );
3577
	}
3578
3579
	/**
3580
	 * Get the internal event log.
3581
	 *
3582
	 * @param $event (string) - only return the specific log events
3583
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3584
	 *
3585
	 * @return array of log events || WP_Error for invalid params
3586
	 */
3587
	public static function get_log( $event = false, $num = false ) {
3588
		if ( $event && ! is_string( $event ) ) {
3589
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with __('First param must be ...g or empty', 'jetpack').

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3590
		}
3591
3592
		if ( $num && ! is_numeric( $num ) ) {
3593
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with __('Second param must be...c or empty', 'jetpack').

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3594
		}
3595
3596
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3597
3598
		// If nothing set - act as it did before, otherwise let's start customizing the output
3599
		if ( ! $num && ! $event ) {
3600
			return $entire_log;
3601
		} else {
3602
			$entire_log = array_reverse( $entire_log );
3603
		}
3604
3605
		$custom_log_output = array();
3606
3607
		if ( $event ) {
3608
			foreach ( $entire_log as $log_event ) {
3609
				if ( $event == $log_event['code'] ) {
3610
					$custom_log_output[] = $log_event;
3611
				}
3612
			}
3613
		} else {
3614
			$custom_log_output = $entire_log;
3615
		}
3616
3617
		if ( $num ) {
3618
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3619
		}
3620
3621
		return $custom_log_output;
3622
	}
3623
3624
	/**
3625
	 * Log modification of important settings.
3626
	 */
3627
	public static function log_settings_change( $option, $old_value, $value ) {
3628
		switch ( $option ) {
3629
			case 'jetpack_sync_non_public_post_stati':
3630
				self::log( $option, $value );
3631
				break;
3632
		}
3633
	}
3634
3635
	/**
3636
	 * Return stat data for WPCOM sync
3637
	 */
3638
	public static function get_stat_data( $encode = true, $extended = true ) {
3639
		$data = Jetpack_Heartbeat::generate_stats_array();
3640
3641
		if ( $extended ) {
3642
			$additional_data = self::get_additional_stat_data();
3643
			$data            = array_merge( $data, $additional_data );
3644
		}
3645
3646
		if ( $encode ) {
3647
			return json_encode( $data );
3648
		}
3649
3650
		return $data;
3651
	}
3652
3653
	/**
3654
	 * Get additional stat data to sync to WPCOM
3655
	 */
3656
	public static function get_additional_stat_data( $prefix = '' ) {
3657
		$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...
3658
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3659
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3660
		$return[ "{$prefix}site-count" ]    = 0;
3661
3662
		if ( function_exists( 'get_blog_count' ) ) {
3663
			$return[ "{$prefix}site-count" ] = get_blog_count();
3664
		}
3665
		return $return;
3666
	}
3667
3668
	private static function get_site_user_count() {
3669
		global $wpdb;
3670
3671
		if ( function_exists( 'wp_is_large_network' ) ) {
3672
			if ( wp_is_large_network( 'users' ) ) {
3673
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3674
			}
3675
		}
3676
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3677
			// It wasn't there, so regenerate the data and save the transient
3678
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3679
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3680
		}
3681
		return $user_count;
3682
	}
3683
3684
	/* Admin Pages */
3685
3686
	function admin_init() {
3687
		// If the plugin is not connected, display a connect message.
3688
		if (
3689
			// the plugin was auto-activated and needs its candy
3690
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3691
		||
3692
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3693
			! Jetpack_Options::get_option( 'activated' )
3694
		) {
3695
			self::plugin_initialize();
3696
		}
3697
3698
		$is_offline_mode = ( new Status() )->is_offline_mode();
3699
		if ( ! self::is_connection_ready() && ! $is_offline_mode ) {
3700
			Jetpack_Connection_Banner::init();
3701
			/** Already documented in automattic/jetpack-connection::src/class-client.php */
3702
		} elseif ( ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) && ! apply_filters( 'jetpack_client_verify_ssl_certs', false ) ) {
3703
			// Upgrade: 1.1 -> 1.1.1
3704
			// Check and see if host can verify the Jetpack servers' SSL certificate
3705
			$args = array();
3706
			Client::_wp_remote_request( self::connection()->api_url( 'test' ), $args, true );
3707
		}
3708
3709
		Jetpack_Recommendations_Banner::init();
3710
3711
		if ( current_user_can( 'manage_options' ) && ! self::permit_ssl() ) {
3712
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3713
		}
3714
3715
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3716
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3717
		add_action( 'admin_enqueue_scripts', array( $this, 'deactivate_dialog' ) );
3718
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3719
3720
		if ( self::is_connection_ready() || $is_offline_mode ) {
3721
			// Artificially throw errors in certain specific cases during plugin activation.
3722
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3723
		}
3724
3725
		// Add custom column in wp-admin/users.php to show whether user is linked.
3726
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3727
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3728
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3729
	}
3730
3731
	function admin_body_class( $admin_body_class = '' ) {
3732
		$classes = explode( ' ', trim( $admin_body_class ) );
3733
3734
		$classes[] = self::is_connection_ready() ? 'jetpack-connected' : 'jetpack-disconnected';
3735
3736
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3737
		return " $admin_body_class ";
3738
	}
3739
3740
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3741
		return $admin_body_class . ' jetpack-pagestyles ';
3742
	}
3743
3744
	/**
3745
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3746
	 * This function artificially throws errors for such cases (per a specific list).
3747
	 *
3748
	 * @param string $plugin The activated plugin.
3749
	 */
3750
	function throw_error_on_activate_plugin( $plugin ) {
3751
		$active_modules = self::get_active_modules();
3752
3753
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3754
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3755
			$throw = false;
3756
3757
			// Try and make sure it really was the stats plugin
3758
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3759
				if ( 'stats.php' == basename( $plugin ) ) {
3760
					$throw = true;
3761
				}
3762
			} else {
3763
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3764
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3765
					$throw = true;
3766
				}
3767
			}
3768
3769
			if ( $throw ) {
3770
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3771
			}
3772
		}
3773
	}
3774
3775
	function intercept_plugin_error_scrape_init() {
3776
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3777
	}
3778
3779
	function intercept_plugin_error_scrape( $action, $result ) {
3780
		if ( ! $result ) {
3781
			return;
3782
		}
3783
3784
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3785
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3786
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3787
			}
3788
		}
3789
	}
3790
3791
	/**
3792
	 * Register the remote file upload request handlers, if needed.
3793
	 *
3794
	 * @access public
3795
	 */
3796
	public function add_remote_request_handlers() {
3797
		// Remote file uploads are allowed only via AJAX requests.
3798
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3799
			return;
3800
		}
3801
3802
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3803
		$remote_request_actions = array(
3804
			'jetpack_upload_file',
3805
			'jetpack_update_file',
3806
		);
3807
3808
		// phpcs:ignore WordPress.Security.NonceVerification
3809
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3810
			return;
3811
		}
3812
3813
		// Require Jetpack authentication for the remote file upload AJAX requests.
3814
		if ( ! $this->connection_manager ) {
3815
			$this->connection_manager = new Connection_Manager();
3816
		}
3817
3818
		$this->connection_manager->require_jetpack_authentication();
3819
3820
		// Register the remote file upload AJAX handlers.
3821
		foreach ( $remote_request_actions as $action ) {
3822
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3823
		}
3824
	}
3825
3826
	/**
3827
	 * Handler for Jetpack remote file uploads.
3828
	 *
3829
	 * @access public
3830
	 */
3831
	public function remote_request_handlers() {
3832
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3833
3834
		switch ( current_filter() ) {
3835
			case 'wp_ajax_nopriv_jetpack_upload_file':
3836
				$response = $this->upload_handler();
3837
				break;
3838
3839
			case 'wp_ajax_nopriv_jetpack_update_file':
3840
				$response = $this->upload_handler( true );
3841
				break;
3842
			default:
3843
				$response = new WP_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
Unused Code introduced by
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...
3844
				break;
3845
		}
3846
3847
		if ( ! $response ) {
3848
			$response = new WP_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
Unused Code introduced by
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...
3849
		}
3850
3851
		if ( is_wp_error( $response ) ) {
3852
			$status_code       = $response->get_error_data();
0 ignored issues
show
Bug introduced by
The method get_error_data() does not seem to exist on object<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...
3853
			$error             = $response->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3854
			$error_description = $response->get_error_message();
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<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...
3855
3856
			if ( ! is_int( $status_code ) ) {
3857
				$status_code = 400;
3858
			}
3859
3860
			status_header( $status_code );
3861
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3862
		}
3863
3864
		status_header( 200 );
3865
		if ( true === $response ) {
3866
			exit;
3867
		}
3868
3869
		die( json_encode( (object) $response ) );
3870
	}
3871
3872
	/**
3873
	 * Uploads a file gotten from the global $_FILES.
3874
	 * If `$update_media_item` is true and `post_id` is defined
3875
	 * the attachment file of the media item (gotten through of the post_id)
3876
	 * will be updated instead of add a new one.
3877
	 *
3878
	 * @param  boolean $update_media_item - update media attachment
3879
	 * @return array - An array describing the uploadind files process
3880
	 */
3881
	function upload_handler( $update_media_item = false ) {
3882
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3883
			return new WP_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
Unused Code introduced by
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...
3884
		}
3885
3886
		$user = wp_authenticate( '', '' );
3887
		if ( ! $user || is_wp_error( $user ) ) {
3888
			return new WP_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
Unused Code introduced by
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...
3889
		}
3890
3891
		wp_set_current_user( $user->ID );
3892
3893
		if ( ! current_user_can( 'upload_files' ) ) {
3894
			return new WP_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
Unused Code introduced by
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...
3895
		}
3896
3897
		if ( empty( $_FILES ) ) {
3898
			return new WP_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
Unused Code introduced by
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...
3899
		}
3900
3901
		foreach ( array_keys( $_FILES ) as $files_key ) {
3902
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3903
				return new WP_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
Unused Code introduced by
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...
3904
			}
3905
		}
3906
3907
		$media_keys = array_keys( $_FILES['media'] );
3908
3909
		$token = ( new Tokens() )->get_access_token( get_current_user_id() );
3910
		if ( ! $token || is_wp_error( $token ) ) {
3911
			return new WP_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
Unused Code introduced by
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...
3912
		}
3913
3914
		$uploaded_files = array();
3915
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3916
		unset( $GLOBALS['post'] );
3917
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3918
			$file = array();
3919
			foreach ( $media_keys as $media_key ) {
3920
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3921
			}
3922
3923
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3924
3925
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3926
			if ( $hmac_provided !== $hmac_file ) {
3927
				$uploaded_files[ $index ] = (object) array(
3928
					'error'             => 'invalid_hmac',
3929
					'error_description' => 'The corresponding HMAC for this file does not match',
3930
				);
3931
				continue;
3932
			}
3933
3934
			$_FILES['.jetpack.upload.'] = $file;
3935
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3936
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3937
				$post_id = 0;
3938
			}
3939
3940
			if ( $update_media_item ) {
3941
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3942
					return new WP_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
Unused Code introduced by
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...
3943
				}
3944
3945
				$media_array = $_FILES['media'];
3946
3947
				$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...
3948
				$file_array['type']     = $media_array['type'][0];
3949
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3950
				$file_array['error']    = $media_array['error'][0];
3951
				$file_array['size']     = $media_array['size'][0];
3952
3953
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3954
3955
				if ( is_wp_error( $edited_media_item ) ) {
3956
					return $edited_media_item;
3957
				}
3958
3959
				$response = (object) array(
3960
					'id'   => (string) $post_id,
3961
					'file' => (string) $edited_media_item->post_title,
3962
					'url'  => (string) wp_get_attachment_url( $post_id ),
3963
					'type' => (string) $edited_media_item->post_mime_type,
3964
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3965
				);
3966
3967
				return (array) array( $response );
3968
			}
3969
3970
			$attachment_id = media_handle_upload(
3971
				'.jetpack.upload.',
3972
				$post_id,
3973
				array(),
3974
				array(
3975
					'action' => 'jetpack_upload_file',
3976
				)
3977
			);
3978
3979
			if ( ! $attachment_id ) {
3980
				$uploaded_files[ $index ] = (object) array(
3981
					'error'             => 'unknown',
3982
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3983
				);
3984
			} elseif ( is_wp_error( $attachment_id ) ) {
3985
				$uploaded_files[ $index ] = (object) array(
3986
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3987
					'error_description' => $attachment_id->get_error_message(),
3988
				);
3989
			} else {
3990
				$attachment               = get_post( $attachment_id );
3991
				$uploaded_files[ $index ] = (object) array(
3992
					'id'   => (string) $attachment_id,
3993
					'file' => $attachment->post_title,
3994
					'url'  => wp_get_attachment_url( $attachment_id ),
3995
					'type' => $attachment->post_mime_type,
3996
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3997
				);
3998
				// Zip files uploads are not supported unless they are done for installation purposed
3999
				// lets delete them in case something goes wrong in this whole process
4000
				if ( 'application/zip' === $attachment->post_mime_type ) {
4001
					// Schedule a cleanup for 2 hours from now in case of failed install.
4002
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
4003
				}
4004
			}
4005
		}
4006
		if ( ! is_null( $global_post ) ) {
4007
			$GLOBALS['post'] = $global_post;
4008
		}
4009
4010
		return $uploaded_files;
4011
	}
4012
4013
	/**
4014
	 * Add help to the Jetpack page
4015
	 *
4016
	 * @since Jetpack (1.2.3)
4017
	 * @return false if not the Jetpack page
4018
	 */
4019
	function admin_help() {
4020
		$current_screen = get_current_screen();
4021
4022
		// Overview
4023
		$current_screen->add_help_tab(
4024
			array(
4025
				'id'      => 'home',
4026
				'title'   => __( 'Home', 'jetpack' ),
4027
				'content' =>
4028
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4029
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
4030
					'<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>',
4031
			)
4032
		);
4033
4034
		// Screen Content
4035
		if ( current_user_can( 'manage_options' ) ) {
4036
			$current_screen->add_help_tab(
4037
				array(
4038
					'id'      => 'settings',
4039
					'title'   => __( 'Settings', 'jetpack' ),
4040
					'content' =>
4041
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4042
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
4043
						'<ol>' .
4044
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
4045
							'<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>' .
4046
						'</ol>' .
4047
						'<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>',
4048
				)
4049
			);
4050
		}
4051
4052
		// Help Sidebar
4053
		$support_url = Redirect::get_url( 'jetpack-support' );
4054
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
4055
		$current_screen->set_help_sidebar(
4056
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
4057
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
4058
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
4059
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
4060
		);
4061
	}
4062
4063
	function admin_menu_css() {
4064
		wp_enqueue_style( 'jetpack-icons' );
4065
	}
4066
4067
	function admin_menu_order() {
4068
		return true;
4069
	}
4070
4071
	function jetpack_menu_order( $menu_order ) {
4072
		$jp_menu_order = array();
4073
4074
		foreach ( $menu_order as $index => $item ) {
4075
			if ( $item != 'jetpack' ) {
4076
				$jp_menu_order[] = $item;
4077
			}
4078
4079
			if ( $index == 0 ) {
4080
				$jp_menu_order[] = 'jetpack';
4081
			}
4082
		}
4083
4084
		return $jp_menu_order;
4085
	}
4086
4087
	function admin_banner_styles() {
4088
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
4089
4090 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
4091
			wp_register_style(
4092
				'jetpack-dops-style',
4093
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
4094
				array(),
4095
				JETPACK__VERSION
4096
			);
4097
		}
4098
4099
		wp_enqueue_style(
4100
			'jetpack',
4101
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
4102
			array( 'jetpack-dops-style' ),
4103
			JETPACK__VERSION . '-20121016'
4104
		);
4105
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
4106
		wp_style_add_data( 'jetpack', 'suffix', $min );
4107
	}
4108
4109
	function plugin_action_links( $actions ) {
4110
4111
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
4112
4113
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_connection_ready() || ( new Status() )->is_offline_mode() ) ) {
4114
			return array_merge(
4115
				$jetpack_home,
4116
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
4117
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
4118
				$actions
4119
			);
4120
		}
4121
4122
		return array_merge( $jetpack_home, $actions );
4123
	}
4124
4125
	/**
4126
	 * Adds the deactivation warning modal if there are other active plugins using the connection
4127
	 *
4128
	 * @param string $hook The current admin page.
4129
	 *
4130
	 * @return void
4131
	 */
4132
	public function deactivate_dialog( $hook ) {
4133
		if (
4134
			'plugins.php' === $hook
4135
			&& self::is_connection_ready()
4136
		) {
4137
4138
			$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4139
4140
			if ( count( $active_plugins_using_connection ) > 1 ) {
4141
4142
				add_thickbox();
4143
4144
				wp_register_script(
4145
					'jp-tracks',
4146
					'//stats.wp.com/w.js',
4147
					array(),
4148
					gmdate( 'YW' ),
4149
					true
4150
				);
4151
4152
				wp_register_script(
4153
					'jp-tracks-functions',
4154
					plugins_url( '_inc/lib/tracks/tracks-callables.js', JETPACK__PLUGIN_FILE ),
4155
					array( 'jp-tracks' ),
4156
					JETPACK__VERSION,
4157
					false
4158
				);
4159
4160
				wp_enqueue_script(
4161
					'jetpack-deactivate-dialog-js',
4162
					Assets::get_file_url_for_environment(
4163
						'_inc/build/jetpack-deactivate-dialog.min.js',
4164
						'_inc/jetpack-deactivate-dialog.js'
4165
					),
4166
					array( 'jquery', 'jp-tracks-functions' ),
4167
					JETPACK__VERSION,
4168
					true
4169
				);
4170
4171
				wp_localize_script(
4172
					'jetpack-deactivate-dialog-js',
4173
					'deactivate_dialog',
4174
					array(
4175
						'title'            => __( 'Deactivate Jetpack', 'jetpack' ),
4176
						'deactivate_label' => __( 'Disconnect and Deactivate', 'jetpack' ),
4177
						'tracksUserData'   => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
4178
					)
4179
				);
4180
4181
				add_action( 'admin_footer', array( $this, 'deactivate_dialog_content' ) );
4182
4183
				wp_enqueue_style( 'jetpack-deactivate-dialog', plugins_url( 'css/jetpack-deactivate-dialog.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
4184
			}
4185
		}
4186
	}
4187
4188
	/**
4189
	 * Outputs the content of the deactivation modal
4190
	 *
4191
	 * @return void
4192
	 */
4193
	public function deactivate_dialog_content() {
4194
		$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4195
		unset( $active_plugins_using_connection['jetpack'] );
4196
		$this->load_view( 'admin/deactivation-dialog.php', $active_plugins_using_connection );
0 ignored issues
show
Bug introduced by
It seems like $active_plugins_using_connection defined by \Automattic\Jetpack\Conn...ugin_Storage::get_all() on line 4194 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...
4197
	}
4198
4199
	/**
4200
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4201
	 *
4202
	 * @param string $login_url The wp-login URL.
4203
	 * @param string $redirect  URL to redirect users after logging in.
4204
	 * @since Jetpack 8.4
4205
	 * @return string
4206
	 */
4207
	public function login_url( $login_url, $redirect ) {
4208
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
4209
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4210
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4211
		}
4212
		return $login_url;
4213
	}
4214
4215
	/**
4216
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4217
	 *
4218
	 * @since Jetpack 8.4
4219
	 */
4220
	public function login_init() {
4221
		// phpcs:ignore WordPress.Security.NonceVerification
4222
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4223
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4224
			wp_safe_redirect(
4225
				add_query_arg(
4226
					array(
4227
						'forceInstall' => 1,
4228
						'url'          => rawurlencode( get_site_url() ),
4229
					),
4230
					// @todo provide way to go to specific calypso env.
4231
					self::get_calypso_host() . 'jetpack/connect'
4232
				)
4233
			);
4234
			exit;
4235
		}
4236
	}
4237
4238
	/*
4239
	 * Registration flow:
4240
	 * 1 - ::admin_page_load() action=register
4241
	 * 2 - ::try_registration()
4242
	 * 3 - ::register()
4243
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4244
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4245
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4246
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4247
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4248
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4249
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4250
	 *       jetpack_id, jetpack_secret, jetpack_public
4251
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4252
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4253
	 * 5 - user logs in with WP.com account
4254
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4255
	 *		- Manager::authorize()
4256
	 *		- Manager::get_token()
4257
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4258
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4259
	 *			- which responds with access_token, token_type, scope
4260
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4261
	 *		- Jetpack::activate_default_modules()
4262
	 *     		- Deactivates deprecated plugins
4263
	 *     		- Activates all default modules
4264
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4265
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4266
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4267
	 *     Done!
4268
	 */
4269
4270
	/**
4271
	 * Handles the page load events for the Jetpack admin page
4272
	 */
4273
	function admin_page_load() {
4274
		$error = false;
4275
4276
		// Make sure we have the right body class to hook stylings for subpages off of.
4277
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4278
4279
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4280
			// Should only be used in intermediate redirects to preserve state across redirects
4281
			self::restate();
4282
		}
4283
4284
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4285
			// @todo: Add validation against a known allowed list.
4286
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4287
			// User clicked in the iframe to link their accounts
4288
			if ( ! self::connection()->is_user_connected() ) {
4289
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4290
4291
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4292
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4293
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4294
4295
				if ( isset( $_GET['notes_iframe'] ) ) {
4296
					$connect_url .= '&notes_iframe';
4297
				}
4298
				wp_redirect( $connect_url );
4299
				exit;
4300
			} else {
4301
				if ( ! isset( $_GET['calypso_env'] ) ) {
4302
					self::state( 'message', 'already_authorized' );
4303
					wp_safe_redirect( self::admin_url() );
4304
					exit;
4305
				} else {
4306
					$connect_url  = $this->build_connect_url( true, false, $from );
4307
					$connect_url .= '&already_authorized=true';
4308
					wp_redirect( $connect_url );
4309
					exit;
4310
				}
4311
			}
4312
		}
4313
4314
		if ( isset( $_GET['action'] ) ) {
4315
			switch ( $_GET['action'] ) {
4316
				case 'authorize_redirect':
4317
					self::log( 'authorize_redirect' );
4318
4319
					add_filter(
4320
						'allowed_redirect_hosts',
4321
						function ( $domains ) {
4322
							$domains[] = 'jetpack.com';
4323
							$domains[] = 'jetpack.wordpress.com';
4324
							$domains[] = 'wordpress.com';
4325
							$domains[] = wp_parse_url( static::get_calypso_host(), PHP_URL_HOST ); // May differ from `wordpress.com`.
4326
							return array_unique( $domains );
4327
						}
4328
					);
4329
4330
					// phpcs:ignore WordPress.Security.NonceVerification.Recommended
4331
					$dest_url = empty( $_GET['dest_url'] ) ? null : $_GET['dest_url'];
4332
4333
					if ( ! $dest_url || ( 0 === stripos( $dest_url, 'https://jetpack.com/' ) && 0 === stripos( $dest_url, 'https://wordpress.com/' ) ) ) {
4334
						// The destination URL is missing or invalid, nothing to do here.
4335
						exit;
4336
					}
4337
4338
					if ( static::connection()->is_connected() && static::connection()->is_user_connected() ) {
4339
						// The user is either already connected, or finished the connection process.
4340
						wp_safe_redirect( $dest_url );
4341
						exit;
4342
					} elseif ( ! empty( $_GET['done'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
4343
						// The user decided not to proceed with setting up the connection.
4344
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4345
						exit;
4346
					}
4347
4348
					$redirect_url = self::admin_url(
4349
						array(
4350
							'page'     => 'jetpack',
4351
							'action'   => 'authorize_redirect',
4352
							'dest_url' => rawurlencode( $dest_url ),
4353
							'done'     => '1',
4354
						)
4355
					);
4356
4357
					wp_safe_redirect( static::build_authorize_url( $redirect_url ) );
0 ignored issues
show
Documentation introduced by
$redirect_url 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...
4358
					exit;
4359
				case 'authorize':
4360
					_doing_it_wrong( __METHOD__, 'The `page=jetpack&action=authorize` webhook is deprecated. Use `handler=jetpack-connection-webhooks&action=authorize` instead', 'Jetpack 9.5.0' );
4361
					( new Connection_Webhooks( $this->connection_manager ) )->handle_authorize();
4362
					exit;
4363
				case 'register':
4364
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4365
						$error = 'cheatin';
4366
						break;
4367
					}
4368
					check_admin_referer( 'jetpack-register' );
4369
					self::log( 'register' );
4370
					self::maybe_set_version_option();
4371
					$registered = self::try_registration();
4372
					if ( is_wp_error( $registered ) ) {
4373
						$error = $registered->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4374
						self::state( 'error', $error );
4375
						self::state( 'error', $registered->get_error_message() );
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4376
4377
						/**
4378
						 * Jetpack registration Error.
4379
						 *
4380
						 * @since 7.5.0
4381
						 *
4382
						 * @param string|int $error The error code.
4383
						 * @param \WP_Error $registered The error object.
4384
						 */
4385
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4386
						break;
4387
					}
4388
4389
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4390
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4391
4392
					/**
4393
					 * Jetpack registration Success.
4394
					 *
4395
					 * @since 7.5.0
4396
					 *
4397
					 * @param string $from 'from' GET parameter;
4398
					 */
4399
					do_action( 'jetpack_connection_register_success', $from );
4400
4401
					$url = $this->build_connect_url( true, $redirect, $from );
4402
4403
					if ( ! empty( $_GET['onboarding'] ) ) {
4404
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4405
					}
4406
4407
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4408
						$url = add_query_arg( 'auth_approved', 'true', $url );
4409
					}
4410
4411
					wp_redirect( $url );
4412
					exit;
4413
				case 'activate':
4414
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4415
						$error = 'cheatin';
4416
						break;
4417
					}
4418
4419
					$module = stripslashes( $_GET['module'] );
4420
					check_admin_referer( "jetpack_activate-$module" );
4421
					self::log( 'activate', $module );
4422
					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...
4423
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4424
					}
4425
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4426
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4427
					exit;
4428
				case 'activate_default_modules':
4429
					check_admin_referer( 'activate_default_modules' );
4430
					self::log( 'activate_default_modules' );
4431
					self::restate();
4432
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4433
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4434
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4435
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4436
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4437
					exit;
4438 View Code Duplication
				case 'disconnect':
4439
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4440
						$error = 'cheatin';
4441
						break;
4442
					}
4443
4444
					check_admin_referer( 'jetpack-disconnect' );
4445
					self::log( 'disconnect' );
4446
					self::disconnect();
4447
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4448
					exit;
4449 View Code Duplication
				case 'reconnect':
4450
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4451
						$error = 'cheatin';
4452
						break;
4453
					}
4454
4455
					check_admin_referer( 'jetpack-reconnect' );
4456
					self::log( 'reconnect' );
4457
					self::disconnect();
4458
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4459
					exit;
4460 View Code Duplication
				case 'deactivate':
4461
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4462
						$error = 'cheatin';
4463
						break;
4464
					}
4465
4466
					$modules = stripslashes( $_GET['module'] );
4467
					check_admin_referer( "jetpack_deactivate-$modules" );
4468
					foreach ( explode( ',', $modules ) as $module ) {
4469
						self::log( 'deactivate', $module );
4470
						self::deactivate_module( $module );
4471
						self::state( 'message', 'module_deactivated' );
4472
					}
4473
					self::state( 'module', $modules );
4474
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4475
					exit;
4476
				case 'unlink':
4477
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4478
					check_admin_referer( 'jetpack-unlink' );
4479
					self::log( 'unlink' );
4480
					$this->connection_manager->disconnect_user();
4481
					self::state( 'message', 'unlinked' );
4482
					if ( 'sub-unlink' == $redirect ) {
4483
						wp_safe_redirect( admin_url() );
4484
					} else {
4485
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4486
					}
4487
					exit;
4488
				case 'onboard':
4489
					if ( ! current_user_can( 'manage_options' ) ) {
4490
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4491
					} else {
4492
						self::create_onboarding_token();
4493
						$url = $this->build_connect_url( true );
4494
4495
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4496
							$url = add_query_arg( 'onboarding', $token, $url );
4497
						}
4498
4499
						$calypso_env = $this->get_calypso_env();
4500
						if ( ! empty( $calypso_env ) ) {
4501
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4502
						}
4503
4504
						wp_redirect( $url );
4505
						exit;
4506
					}
4507
					exit;
4508
				default:
4509
					/**
4510
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4511
					 *
4512
					 * @since 2.6.0
4513
					 *
4514
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4515
					 */
4516
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4517
			}
4518
		}
4519
4520
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4521
			self::activate_new_modules( true );
4522
		}
4523
4524
		$message_code = self::state( 'message' );
4525
		if ( self::state( 'optin-manage' ) ) {
4526
			$activated_manage = $message_code;
4527
			$message_code     = 'jetpack-manage';
4528
		}
4529
4530
		switch ( $message_code ) {
4531
			case 'jetpack-manage':
4532
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4533
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4534
				$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>';
4535
				if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4536
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4537
				}
4538
				break;
4539
4540
		}
4541
4542
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4543
4544
		if ( ! empty( $deactivated_plugins ) ) {
4545
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4546
			$deactivated_titles  = array();
4547
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4548
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4549
					continue;
4550
				}
4551
4552
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4553
			}
4554
4555
			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...
4556
				if ( $this->message ) {
4557
					$this->message .= "<br /><br />\n";
4558
				}
4559
4560
				$this->message .= wp_sprintf(
4561
					_n(
4562
						'Jetpack contains the most recent version of the old %l plugin.',
4563
						'Jetpack contains the most recent versions of the old %l plugins.',
4564
						count( $deactivated_titles ),
4565
						'jetpack'
4566
					),
4567
					$deactivated_titles
4568
				);
4569
4570
				$this->message .= "<br />\n";
4571
4572
				$this->message .= _n(
4573
					'The old version has been deactivated and can be removed from your site.',
4574
					'The old versions have been deactivated and can be removed from your site.',
4575
					count( $deactivated_titles ),
4576
					'jetpack'
4577
				);
4578
			}
4579
		}
4580
4581
		$this->privacy_checks = self::state( 'privacy_checks' );
4582
4583
		if ( $this->message || $this->error || $this->privacy_checks ) {
4584
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4585
		}
4586
4587
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4588
	}
4589
4590
	function admin_notices() {
4591
4592
		if ( $this->error ) {
4593
			?>
4594
<div id="message" class="jetpack-message jetpack-err">
4595
	<div class="squeezer">
4596
		<h2>
4597
			<?php
4598
			echo wp_kses(
4599
				$this->error,
4600
				array(
4601
					'a'      => array( 'href' => array() ),
4602
					'small'  => true,
4603
					'code'   => true,
4604
					'strong' => true,
4605
					'br'     => true,
4606
					'b'      => true,
4607
				)
4608
			);
4609
			?>
4610
			</h2>
4611
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4612
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4613
<?php	endif; ?>
4614
	</div>
4615
</div>
4616
			<?php
4617
		}
4618
4619
		if ( $this->message ) {
4620
			?>
4621
<div id="message" class="jetpack-message">
4622
	<div class="squeezer">
4623
		<h2>
4624
			<?php
4625
			echo wp_kses(
4626
				$this->message,
4627
				array(
4628
					'strong' => array(),
4629
					'a'      => array( 'href' => true ),
4630
					'br'     => true,
4631
				)
4632
			);
4633
			?>
4634
			</h2>
4635
	</div>
4636
</div>
4637
			<?php
4638
		}
4639
4640
		if ( $this->privacy_checks ) :
4641
			$module_names = $module_slugs = array();
4642
4643
			$privacy_checks = explode( ',', $this->privacy_checks );
4644
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4645
			foreach ( $privacy_checks as $module_slug ) {
4646
				$module = self::get_module( $module_slug );
4647
				if ( ! $module ) {
4648
					continue;
4649
				}
4650
4651
				$module_slugs[] = $module_slug;
4652
				$module_names[] = "<strong>{$module['name']}</strong>";
4653
			}
4654
4655
			$module_slugs = join( ',', $module_slugs );
4656
			?>
4657
<div id="message" class="jetpack-message jetpack-err">
4658
	<div class="squeezer">
4659
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4660
		<p>
4661
			<?php
4662
			echo wp_kses(
4663
				wptexturize(
4664
					wp_sprintf(
4665
						_nx(
4666
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4667
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4668
							count( $privacy_checks ),
4669
							'%l = list of Jetpack module/feature names',
4670
							'jetpack'
4671
						),
4672
						$module_names
4673
					)
4674
				),
4675
				array( 'strong' => true )
4676
			);
4677
4678
			echo "\n<br />\n";
4679
4680
			echo wp_kses(
4681
				sprintf(
4682
					_nx(
4683
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4684
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4685
						count( $privacy_checks ),
4686
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4687
						'jetpack'
4688
					),
4689
					wp_nonce_url(
4690
						self::admin_url(
4691
							array(
4692
								'page'   => 'jetpack',
4693
								'action' => 'deactivate',
4694
								'module' => urlencode( $module_slugs ),
4695
							)
4696
						),
4697
						"jetpack_deactivate-$module_slugs"
4698
					),
4699
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4700
				),
4701
				array(
4702
					'a' => array(
4703
						'href'  => true,
4704
						'title' => true,
4705
					),
4706
				)
4707
			);
4708
			?>
4709
		</p>
4710
	</div>
4711
</div>
4712
			<?php
4713
endif;
4714
	}
4715
4716
	/**
4717
	 * We can't always respond to a signed XML-RPC request with a
4718
	 * helpful error message. In some circumstances, doing so could
4719
	 * leak information.
4720
	 *
4721
	 * Instead, track that the error occurred via a Jetpack_Option,
4722
	 * and send that data back in the heartbeat.
4723
	 * All this does is increment a number, but it's enough to find
4724
	 * trends.
4725
	 *
4726
	 * @param WP_Error $xmlrpc_error The error produced during
4727
	 *                               signature validation.
4728
	 */
4729
	function track_xmlrpc_error( $xmlrpc_error ) {
4730
		$code = is_wp_error( $xmlrpc_error )
4731
			? $xmlrpc_error->get_error_code()
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4732
			: 'should-not-happen';
4733
4734
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4735
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4736
			// No need to update the option if we already have
4737
			// this code stored.
4738
			return;
4739
		}
4740
		$xmlrpc_errors[ $code ] = true;
4741
4742
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4743
	}
4744
4745
	/**
4746
	 * Initialize the jetpack stats instance only when needed
4747
	 *
4748
	 * @return void
4749
	 */
4750
	private function initialize_stats() {
4751
		if ( is_null( $this->a8c_mc_stats_instance ) ) {
4752
			$this->a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4753
		}
4754
	}
4755
4756
	/**
4757
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4758
	 */
4759
	function stat( $group, $detail ) {
4760
		$this->initialize_stats();
4761
		$this->a8c_mc_stats_instance->add( $group, $detail );
4762
4763
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4764
		$this->stats = $this->a8c_mc_stats_instance->get_current_stats();
4765
	}
4766
4767
	/**
4768
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4769
	 */
4770
	function do_stats( $method = '' ) {
4771
		$this->initialize_stats();
4772
		if ( 'server_side' === $method ) {
4773
			$this->a8c_mc_stats_instance->do_server_side_stats();
4774
		} else {
4775
			$this->a8c_mc_stats_instance->do_stats();
4776
		}
4777
4778
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4779
		$this->stats = array();
4780
	}
4781
4782
	/**
4783
	 * Runs stats code for a one-off, server-side.
4784
	 *
4785
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4786
	 *
4787
	 * @return bool If it worked.
4788
	 */
4789
	static function do_server_side_stat( $args ) {
4790
		$url                   = self::build_stats_url( $args );
4791
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4792
		return $a8c_mc_stats_instance->do_server_side_stat( $url );
4793
	}
4794
4795
	/**
4796
	 * Builds the stats url.
4797
	 *
4798
	 * @param $args array|string The arguments to append to the URL.
4799
	 *
4800
	 * @return string The URL to be pinged.
4801
	 */
4802
	static function build_stats_url( $args ) {
4803
4804
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4805
		return $a8c_mc_stats_instance->build_stats_url( $args );
4806
4807
	}
4808
4809
	/**
4810
	 * Builds a URL to the Jetpack connection auth page
4811
	 *
4812
	 * @since 3.9.5
4813
	 *
4814
	 * @param bool        $raw If true, URL will not be escaped.
4815
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4816
	 *                              If string, will be a custom redirect.
4817
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4818
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4819
	 *
4820
	 * @return string Connect URL
4821
	 */
4822
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4823
		$site_id    = Jetpack_Options::get_option( 'id' );
4824
		$blog_token = ( new Tokens() )->get_access_token();
4825
4826
		if ( $register || ! $blog_token || ! $site_id ) {
4827
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4828
4829
			if ( ! empty( $redirect ) ) {
4830
				$url = add_query_arg(
4831
					'redirect',
4832
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4833
					$url
4834
				);
4835
			}
4836
4837
			if ( is_network_admin() ) {
4838
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4839
			}
4840
4841
			$calypso_env = self::get_calypso_env();
4842
4843
			if ( ! empty( $calypso_env ) ) {
4844
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4845
			}
4846
		} else {
4847
4848
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4849
			// because otherwise this logic can get us in to a loop.
4850
			$last_connect_url_check = (int) Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' );
4851
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4852
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4853
4854
				$response = Client::wpcom_json_api_request_as_blog(
4855
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4856
					'1.1'
4857
				);
4858
4859
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4860
4861
					// Generating a register URL instead to refresh the existing token
4862
					return $this->build_connect_url( $raw, $redirect, $from, true );
4863
				}
4864
			}
4865
4866
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4822 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...
4867
		}
4868
4869
		if ( $from ) {
4870
			$url = add_query_arg( 'from', $from, $url );
4871
		}
4872
4873
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4874
		/**
4875
		 * Filter the URL used when connecting a user to a WordPress.com account.
4876
		 *
4877
		 * @since 8.1.0
4878
		 *
4879
		 * @param string $url Connection URL.
4880
		 * @param bool   $raw If true, URL will not be escaped.
4881
		 */
4882
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
0 ignored issues
show
Unused Code introduced by
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...
4883
	}
4884
4885
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4886
4887
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4888
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4889
4890
		if ( $iframe ) {
4891
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4892
		}
4893
4894
		$c8n = self::connection();
4895
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
0 ignored issues
show
Documentation introduced by
$redirect is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4896
4897
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4898
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4899
4900
		if ( $iframe ) {
4901
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4902
		}
4903
4904
		/**
4905
		 * Filter the URL used when authorizing a user to a WordPress.com account.
4906
		 *
4907
		 * @since 8.9.0
4908
		 *
4909
		 * @param string $url Connection URL.
4910
		 */
4911
		return apply_filters( 'jetpack_build_authorize_url', $url );
4912
	}
4913
4914
	/**
4915
	 * Filters the connection URL parameter array.
4916
	 *
4917
	 * @param array $args default URL parameters used by the package.
4918
	 * @return array the modified URL arguments array.
4919
	 */
4920
	public static function filter_connect_request_body( $args ) {
4921
		if (
4922
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4923
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4924
		) {
4925
			$gp_locale      = GP_Locales::by_field( 'wp_locale', get_locale() );
4926
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4927
				? $gp_locale->slug
4928
				: '';
4929
		}
4930
4931
		$tracking        = new Tracking();
4932
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4933
4934
		$args = array_merge(
4935
			$args,
4936
			array(
4937
				'_ui' => $tracks_identity['_ui'],
4938
				'_ut' => $tracks_identity['_ut'],
4939
			)
4940
		);
4941
4942
		$calypso_env = self::get_calypso_env();
4943
4944
		if ( ! empty( $calypso_env ) ) {
4945
			$args['calypso_env'] = $calypso_env;
4946
		}
4947
4948
		return $args;
4949
	}
4950
4951
	/**
4952
	 * Filters the URL that will process the connection data. It can be different from the URL
4953
	 * that we send the user to after everything is done.
4954
	 *
4955
	 * @param String $processing_url the default redirect URL used by the package.
4956
	 * @return String the modified URL.
4957
	 *
4958
	 * @deprecated since Jetpack 9.5.0
4959
	 */
4960
	public static function filter_connect_processing_url( $processing_url ) {
4961
		_deprecated_function( __METHOD__, 'jetpack-9.5' );
4962
4963
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4964
		return $processing_url;
4965
	}
4966
4967
	/**
4968
	 * Filters the redirection URL that is used for connect requests. The redirect
4969
	 * URL should return the user back to the Jetpack console.
4970
	 *
4971
	 * @param String $redirect the default redirect URL used by the package.
4972
	 * @return String the modified URL.
4973
	 */
4974
	public static function filter_connect_redirect_url( $redirect ) {
4975
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4976
		$redirect           = $redirect
4977
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4978
			: $jetpack_admin_page;
4979
4980
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4981
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4982
		}
4983
4984
		return $redirect;
4985
	}
4986
4987
	/**
4988
	 * This action fires at the beginning of the Manager::authorize method.
4989
	 */
4990
	public static function authorize_starting() {
4991
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4992
		// Checking if site has been active/connected previously before recording unique connection.
4993
		if ( ! $jetpack_unique_connection ) {
4994
			// jetpack_unique_connection option has never been set.
4995
			$jetpack_unique_connection = array(
4996
				'connected'    => 0,
4997
				'disconnected' => 0,
4998
				'version'      => '3.6.1',
4999
			);
5000
5001
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
5002
5003
			// Track unique connection.
5004
			$jetpack = self::init();
5005
5006
			$jetpack->stat( 'connections', 'unique-connection' );
5007
			$jetpack->do_stats( 'server_side' );
5008
		}
5009
5010
		// Increment number of times connected.
5011
		$jetpack_unique_connection['connected'] += 1;
5012
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
5013
	}
5014
5015
	/**
5016
	 * This action fires at the end of the Manager::authorize method when a secondary user is
5017
	 * linked.
5018
	 */
5019
	public static function authorize_ending_linked() {
5020
		// Don't activate anything since we are just connecting a user.
5021
		self::state( 'message', 'linked' );
5022
	}
5023
5024
	/**
5025
	 * This action fires at the end of the Manager::authorize method when the master user is
5026
	 * authorized.
5027
	 *
5028
	 * @param array $data The request data.
5029
	 */
5030
	public static function authorize_ending_authorized( $data ) {
5031
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
5032
		self::invalidate_onboarding_token();
5033
5034
		// If redirect_uri is SSO, ensure SSO module is enabled.
5035
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
5036
5037
		/** This filter is documented in class.jetpack-cli.php */
5038
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
5039
5040
		$activate_sso = (
5041
			isset( $redirect_options['action'] ) &&
5042
			'jetpack-sso' === $redirect_options['action'] &&
5043
			$jetpack_start_enable_sso
5044
		);
5045
5046
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
5047
5048
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
5049
	}
5050
5051
	/**
5052
	 * Fires on the jetpack_site_registered hook and acitvates default modules
5053
	 */
5054
	public static function activate_default_modules_on_site_register() {
5055
		$active_modules = Jetpack_Options::get_option( 'active_modules' );
5056
		if ( $active_modules ) {
5057
			self::delete_active_modules();
5058
5059
			// If there was previously activated modules (a reconnection), re-activate them all including those that require a user, and do not re-activate those that have been deactivated.
5060
			self::activate_default_modules( 999, 1, $active_modules, false );
0 ignored issues
show
Documentation introduced by
999 is of type integer, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
5061
		} else {
5062
			// On a fresh new connection, at this point we activate only modules that do not require a user connection.
5063
			self::activate_default_modules( false, false, array(), false, null, null, false );
5064
		}
5065
5066
		// Since this is a fresh connection, be sure to clear out IDC options.
5067
		Jetpack_IDC::clear_all_idc_options();
5068
	}
5069
5070
	/**
5071
	 * This action fires at the end of the REST_Connector connection_reconnect method when the
5072
	 * reconnect process is completed.
5073
	 * Note that this currently only happens when we don't need the user to re-authorize
5074
	 * their WP.com account, eg in cases where we are restoring a connection with
5075
	 * unhealthy blog token.
5076
	 */
5077
	public static function reconnection_completed() {
5078
		self::state( 'message', 'reconnection_completed' );
5079
	}
5080
5081
	/**
5082
	 * Get our assumed site creation date.
5083
	 * Calculated based on the earlier date of either:
5084
	 * - Earliest admin user registration date.
5085
	 * - Earliest date of post of any post type.
5086
	 *
5087
	 * @since 7.2.0
5088
	 * @deprecated since 7.8.0
5089
	 *
5090
	 * @return string Assumed site creation date and time.
5091
	 */
5092
	public static function get_assumed_site_creation_date() {
5093
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
5094
		return self::connection()->get_assumed_site_creation_date();
5095
	}
5096
5097 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
5098
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
5099
5100
		if ( $activation_source_name ) {
5101
			$args['_as'] = urlencode( $activation_source_name );
5102
		}
5103
5104
		if ( $activation_source_keyword ) {
5105
			$args['_ak'] = urlencode( $activation_source_keyword );
5106
		}
5107
	}
5108
5109
	function build_reconnect_url( $raw = false ) {
5110
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
5111
		return $raw ? $url : esc_url( $url );
5112
	}
5113
5114
	public static function admin_url( $args = null ) {
5115
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
0 ignored issues
show
Documentation introduced by
array('page' => 'jetpack') is of type array<string,string,{"page":"string"}>, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
5116
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
5117
		return $url;
5118
	}
5119
5120
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
5121
		$actionurl = str_replace( '&amp;', '&', $actionurl );
5122
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
5123
	}
5124
5125
	function dismiss_jetpack_notice() {
5126
5127
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
5128
			return;
5129
		}
5130
5131
		switch ( $_GET['jetpack-notice'] ) {
5132
			case 'dismiss':
5133
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
5134
5135
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
5136
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
5137
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
5138
				}
5139
				break;
5140
		}
5141
	}
5142
5143
	public static function sort_modules( $a, $b ) {
5144
		if ( $a['sort'] == $b['sort'] ) {
5145
			return 0;
5146
		}
5147
5148
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
5149
	}
5150
5151
	function ajax_recheck_ssl() {
5152
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5153
		$result = self::permit_ssl( true );
5154
		wp_send_json(
5155
			array(
5156
				'enabled' => $result,
5157
				'message' => get_transient( 'jetpack_https_test_message' ),
5158
			)
5159
		);
5160
	}
5161
5162
	/* Client API */
5163
5164
	/**
5165
	 * Returns the requested Jetpack API URL
5166
	 *
5167
	 * @deprecated since 7.7
5168
	 * @return string
5169
	 */
5170
	public static function api_url( $relative_url ) {
5171
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5172
		$connection = self::connection();
5173
		return $connection->api_url( $relative_url );
5174
	}
5175
5176
	/**
5177
	 * @deprecated 8.0
5178
	 *
5179
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requests.
5180
	 * But we no longer fix "bad hosts" anyway, outbound HTTPS is required for Jetpack to function.
5181
	 */
5182
	public static function fix_url_for_bad_hosts( $url ) {
5183
		_deprecated_function( __METHOD__, 'jetpack-8.0' );
5184
		return $url;
5185
	}
5186
5187
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5188
		// Default to a blog token.
5189
		$token_type = 'blog';
5190
5191
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5192
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5193
			if ( ! empty( $_GET['onboarding'] ) ) {
5194
				$jpo = $_GET;
5195
			} else {
5196
				$jpo = json_decode( $request_data, true );
5197
			}
5198
5199
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5200
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5201
5202
			if (
5203
				isset( $jpo_user )
5204
				&& isset( $jpo_token )
5205
				&& is_email( $jpo_user )
5206
				&& ctype_alnum( $jpo_token )
5207
				&& isset( $_GET['rest_route'] )
5208
				&& self::validate_onboarding_token_action(
5209
					$jpo_token,
5210
					$_GET['rest_route']
5211
				)
5212
			) {
5213
				$jp_user = get_user_by( 'email', $jpo_user );
5214
				if ( is_a( $jp_user, 'WP_User' ) ) {
5215
					wp_set_current_user( $jp_user->ID );
5216
					$user_can = is_multisite()
5217
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5218
						: current_user_can( 'manage_options' );
5219
					if ( $user_can ) {
5220
						$token_type              = 'user';
5221
						$token->external_user_id = $jp_user->ID;
5222
					}
5223
				}
5224
			}
5225
5226
			$token_data['type']    = $token_type;
5227
			$token_data['user_id'] = $token->external_user_id;
5228
		}
5229
5230
		return $token_data;
5231
	}
5232
5233
	/**
5234
	 * Create a random secret for validating onboarding payload
5235
	 *
5236
	 * @return string Secret token
5237
	 */
5238
	public static function create_onboarding_token() {
5239
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5240
			$token = wp_generate_password( 32, false );
5241
			Jetpack_Options::update_option( 'onboarding', $token );
5242
		}
5243
5244
		return $token;
5245
	}
5246
5247
	/**
5248
	 * Remove the onboarding token
5249
	 *
5250
	 * @return bool True on success, false on failure
5251
	 */
5252
	public static function invalidate_onboarding_token() {
5253
		return Jetpack_Options::delete_option( 'onboarding' );
5254
	}
5255
5256
	/**
5257
	 * Validate an onboarding token for a specific action
5258
	 *
5259
	 * @return boolean True if token/action pair is accepted, false if not
5260
	 */
5261
	public static function validate_onboarding_token_action( $token, $action ) {
5262
		// Compare tokens, bail if tokens do not match
5263
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5264
			return false;
5265
		}
5266
5267
		// List of valid actions we can take
5268
		$valid_actions = array(
5269
			'/jetpack/v4/settings',
5270
		);
5271
5272
		// Only allow valid actions.
5273
		if ( ! in_array( $action, $valid_actions ) ) {
5274
			return false;
5275
		}
5276
5277
		return true;
5278
	}
5279
5280
	/**
5281
	 * Checks to see if the URL is using SSL to connect with Jetpack
5282
	 *
5283
	 * @since 2.3.3
5284
	 * @return boolean
5285
	 */
5286
	public static function permit_ssl( $force_recheck = false ) {
5287
		// Do some fancy tests to see if ssl is being supported
5288
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5289
			$message = '';
5290
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5291
				$ssl = 0;
5292
			} else {
5293
				$ssl = 1;
5294
5295
				if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5296
					$ssl     = 0;
5297
					$message = __( 'WordPress reports no SSL support', 'jetpack' );
5298
				} else {
5299
					$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5300
					if ( is_wp_error( $response ) ) {
5301
						$ssl     = 0;
5302
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5303
					} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5304
						$ssl     = 0;
5305
						$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5306
					}
5307
				}
5308
			}
5309
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5310
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5311
		}
5312
5313
		return (bool) $ssl;
5314
	}
5315
5316
	/*
5317
	 * Displays an admin_notice, alerting the user that outbound SSL isn't working.
5318
	 */
5319
	public function alert_auto_ssl_fail() {
5320
		if ( ! current_user_can( 'manage_options' ) ) {
5321
			return;
5322
		}
5323
5324
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5325
		?>
5326
5327
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5328
			<div class="jp-banner__content">
5329
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5330
				<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>
5331
				<p>
5332
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5333
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5334
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5335
				</p>
5336
				<p>
5337
					<?php
5338
					printf(
5339
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5340
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5341
						esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5342
					);
5343
					?>
5344
				</p>
5345
			</div>
5346
		</div>
5347
		<style>
5348
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5349
		</style>
5350
		<script type="text/javascript">
5351
			jQuery( document ).ready( function( $ ) {
5352
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5353
					var $this = $( this );
5354
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5355
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5356
					e.preventDefault();
5357
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5358
					$.post( ajaxurl, data )
5359
					  .done( function( response ) {
5360
						  if ( response.enabled ) {
5361
							  $( '#jetpack-ssl-warning' ).hide();
5362
						  } else {
5363
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5364
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5365
						  }
5366
					  }.bind( $this ) );
5367
				} );
5368
			} );
5369
		</script>
5370
5371
		<?php
5372
	}
5373
5374
	/**
5375
	 * Returns the Jetpack XML-RPC API
5376
	 *
5377
	 * @deprecated 8.0 Use Connection_Manager instead.
5378
	 * @return string
5379
	 */
5380
	public static function xmlrpc_api_url() {
5381
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5382
		return self::connection()->xmlrpc_api_url();
5383
	}
5384
5385
	/**
5386
	 * Returns the connection manager object.
5387
	 *
5388
	 * @return Automattic\Jetpack\Connection\Manager
5389
	 */
5390
	public static function connection() {
5391
		$jetpack = static::init();
5392
5393
		// If the connection manager hasn't been instantiated, do that now.
5394
		if ( ! $jetpack->connection_manager ) {
5395
			$jetpack->connection_manager = new Connection_Manager( 'jetpack' );
5396
		}
5397
5398
		return $jetpack->connection_manager;
5399
	}
5400
5401
	/**
5402
	 * Creates two secret tokens and the end of life timestamp for them.
5403
	 *
5404
	 * Note these tokens are unique per call, NOT static per site for connecting.
5405
	 *
5406
	 * @deprecated 9.5 Use Automattic\Jetpack\Connection\Secrets->generate() instead.
5407
	 *
5408
	 * @since 2.6
5409
	 * @param String  $action  The action name.
5410
	 * @param Integer $user_id The user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be false|integer?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5411
	 * @param Integer $exp     Expiration time in seconds.
5412
	 * @return array
5413
	 */
5414
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5415
		_deprecated_function( __METHOD__, 'jetpack-9.5', 'Automattic\\Jetpack\\Connection\\Secrets->generate' );
5416
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5417
	}
5418
5419
	public static function get_secrets( $action, $user_id ) {
5420
		$secrets = ( new Secrets() )->get( $action, $user_id );
5421
5422
		if ( Secrets::SECRETS_MISSING === $secrets ) {
5423
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_missing'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5424
		}
5425
5426
		if ( Secrets::SECRETS_EXPIRED === $secrets ) {
5427
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_expired'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5428
		}
5429
5430
		return $secrets;
5431
	}
5432
5433
	/**
5434
	 * Builds the timeout limit for queries talking with the wpcom servers.
5435
	 *
5436
	 * Based on local php max_execution_time in php.ini
5437
	 *
5438
	 * @since 2.6
5439
	 * @return int
5440
	 * @deprecated
5441
	 **/
5442
	public function get_remote_query_timeout_limit() {
5443
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5444
		return self::get_max_execution_time();
5445
	}
5446
5447
	/**
5448
	 * Builds the timeout limit for queries talking with the wpcom servers.
5449
	 *
5450
	 * Based on local php max_execution_time in php.ini
5451
	 *
5452
	 * @since 5.4
5453
	 * @return int
5454
	 **/
5455
	public static function get_max_execution_time() {
5456
		$timeout = (int) ini_get( 'max_execution_time' );
5457
5458
		// Ensure exec time set in php.ini
5459
		if ( ! $timeout ) {
5460
			$timeout = 30;
5461
		}
5462
		return $timeout;
5463
	}
5464
5465
	/**
5466
	 * Sets a minimum request timeout, and returns the current timeout
5467
	 *
5468
	 * @since 5.4
5469
	 **/
5470 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5471
		$timeout = self::get_max_execution_time();
5472
		if ( $timeout < $min_timeout ) {
5473
			$timeout = $min_timeout;
5474
			set_time_limit( $timeout );
5475
		}
5476
		return $timeout;
5477
	}
5478
5479
	/**
5480
	 * Takes the response from the Jetpack register new site endpoint and
5481
	 * verifies it worked properly.
5482
	 *
5483
	 * @since 2.6
5484
	 * @deprecated since 7.7.0
5485
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5486
	 **/
5487
	public function validate_remote_register_response() {
5488
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5489
	}
5490
5491
	/**
5492
	 * @return bool|WP_Error
5493
	 */
5494
	public static function register() {
5495
		$tracking = new Tracking();
5496
		$tracking->record_user_event( 'jpc_register_begin' );
5497
5498
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5499
5500
		$connection   = self::connection();
5501
		$registration = $connection->register();
5502
5503
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5504
5505
		if ( ! $registration || is_wp_error( $registration ) ) {
5506
			return $registration;
5507
		}
5508
5509
		return true;
5510
	}
5511
5512
	/**
5513
	 * Filters the registration request body to include tracking properties.
5514
	 *
5515
	 * @param array $properties
5516
	 * @return array amended properties.
5517
	 */
5518 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5519
		$tracking        = new Tracking();
5520
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5521
5522
		return array_merge(
5523
			$properties,
5524
			array(
5525
				'_ui' => $tracks_identity['_ui'],
5526
				'_ut' => $tracks_identity['_ut'],
5527
			)
5528
		);
5529
	}
5530
5531
	/**
5532
	 * Filters the token request body to include tracking properties.
5533
	 *
5534
	 * @param array $properties
5535
	 * @return array amended properties.
5536
	 */
5537 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5538
		$tracking        = new Tracking();
5539
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5540
5541
		return array_merge(
5542
			$properties,
5543
			array(
5544
				'_ui' => $tracks_identity['_ui'],
5545
				'_ut' => $tracks_identity['_ut'],
5546
			)
5547
		);
5548
	}
5549
5550
	/**
5551
	 * If the db version is showing something other that what we've got now, bump it to current.
5552
	 *
5553
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
Documentation introduced by
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
5554
	 */
5555
	public static function maybe_set_version_option() {
5556
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5557
		if ( JETPACK__VERSION != $version ) {
5558
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5559
5560
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5561
				/** This action is documented in class.jetpack.php */
5562
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5563
			}
5564
5565
			return true;
5566
		}
5567
		return false;
5568
	}
5569
5570
	/* Client Server API */
5571
5572
	/**
5573
	 * Loads the Jetpack XML-RPC client.
5574
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5575
	 *
5576
	 * @deprecated since 7.7.0
5577
	 */
5578
	public static function load_xml_rpc_client() {
5579
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5580
	}
5581
5582
	/**
5583
	 * Resets the saved authentication state in between testing requests.
5584
	 *
5585
	 * @deprecated since 8.9.0
5586
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::reset_saved_auth_state()
5587
	 */
5588
	public function reset_saved_auth_state() {
5589
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::reset_saved_auth_state' );
5590
		Connection_Rest_Authentication::init()->reset_saved_auth_state();
5591
	}
5592
5593
	/**
5594
	 * Verifies the signature of the current request.
5595
	 *
5596
	 * @deprecated since 7.7.0
5597
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5598
	 *
5599
	 * @return false|array
5600
	 */
5601
	public function verify_xml_rpc_signature() {
5602
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5603
		return self::connection()->verify_xml_rpc_signature();
5604
	}
5605
5606
	/**
5607
	 * Verifies the signature of the current request.
5608
	 *
5609
	 * This function has side effects and should not be used. Instead,
5610
	 * use the memoized version `->verify_xml_rpc_signature()`.
5611
	 *
5612
	 * @deprecated since 7.7.0
5613
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5614
	 * @internal
5615
	 */
5616
	private function internal_verify_xml_rpc_signature() {
5617
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5618
	}
5619
5620
	/**
5621
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5622
	 *
5623
	 * @deprecated since 7.7.0
5624
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5625
	 *
5626
	 * @param \WP_User|mixed $user     User object if authenticated.
5627
	 * @param string         $username Username.
5628
	 * @param string         $password Password string.
5629
	 * @return \WP_User|mixed Authenticated user or error.
5630
	 */
5631 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5632
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5633
5634
		if ( ! $this->connection_manager ) {
5635
			$this->connection_manager = new Connection_Manager();
5636
		}
5637
5638
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5639
	}
5640
5641
	/**
5642
	 * Authenticates requests from Jetpack server to WP REST API endpoints.
5643
	 * Uses the existing XMLRPC request signing implementation.
5644
	 *
5645
	 * @deprecated since 8.9.0
5646
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authenticate()
5647
	 */
5648
	function wp_rest_authenticate( $user ) {
5649
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::wp_rest_authenticate' );
5650
		return Connection_Rest_Authentication::init()->wp_rest_authenticate( $user );
5651
	}
5652
5653
	/**
5654
	 * Report authentication status to the WP REST API.
5655
	 *
5656
	 * @deprecated since 8.9.0
5657
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
5658
	 *
5659
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
5660
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5661
	 */
5662
	public function wp_rest_authentication_errors( $value ) {
5663
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::wp_rest_authenication_errors' );
5664
		return Connection_Rest_Authentication::init()->wp_rest_authentication_errors( $value );
5665
	}
5666
5667
	/**
5668
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5669
	 * Capture it here so we can verify the signature later.
5670
	 *
5671
	 * @deprecated since 7.7.0
5672
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5673
	 *
5674
	 * @param array $methods XMLRPC methods.
5675
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5676
	 */
5677 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5678
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5679
5680
		if ( ! $this->connection_manager ) {
5681
			$this->connection_manager = new Connection_Manager();
5682
		}
5683
5684
		return $this->connection_manager->xmlrpc_methods( $methods );
5685
	}
5686
5687
	/**
5688
	 * Register additional public XMLRPC methods.
5689
	 *
5690
	 * @deprecated since 7.7.0
5691
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5692
	 *
5693
	 * @param array $methods Public XMLRPC methods.
5694
	 * @return array Public XMLRPC methods, with the getOptions one.
5695
	 */
5696 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5697
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5698
5699
		if ( ! $this->connection_manager ) {
5700
			$this->connection_manager = new Connection_Manager();
5701
		}
5702
5703
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5704
	}
5705
5706
	/**
5707
	 * Handles a getOptions XMLRPC method call.
5708
	 *
5709
	 * @deprecated since 7.7.0
5710
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5711
	 *
5712
	 * @param array $args method call arguments.
5713
	 * @return array an amended XMLRPC server options array.
5714
	 */
5715 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5716
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5717
5718
		if ( ! $this->connection_manager ) {
5719
			$this->connection_manager = new Connection_Manager();
5720
		}
5721
5722
		return $this->connection_manager->jetpack_getOptions( $args );
0 ignored issues
show
Bug introduced by
The method jetpack_getOptions() does not exist on Automattic\Jetpack\Connection\Manager. Did you maybe mean jetpack_get_options()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
5723
	}
5724
5725
	/**
5726
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5727
	 *
5728
	 * @deprecated since 7.7.0
5729
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5730
	 *
5731
	 * @param array $options Standard Core options.
5732
	 * @return array Amended options.
5733
	 */
5734 View Code Duplication
	public function xmlrpc_options( $options ) {
5735
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5736
5737
		if ( ! $this->connection_manager ) {
5738
			$this->connection_manager = new Connection_Manager();
5739
		}
5740
5741
		return $this->connection_manager->xmlrpc_options( $options );
5742
	}
5743
5744
	/**
5745
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5746
	 * SET: state( $key, $value );
5747
	 * GET: $value = state( $key );
5748
	 *
5749
	 * @param string $key
0 ignored issues
show
Documentation introduced by
Should the type for parameter $key not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5750
	 * @param string $value
0 ignored issues
show
Documentation introduced by
Should the type for parameter $value not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5751
	 * @param bool   $restate private
5752
	 */
5753
	public static function state( $key = null, $value = null, $restate = false ) {
5754
		static $state = array();
5755
		static $path, $domain;
5756
		if ( ! isset( $path ) ) {
5757
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5758
			$admin_url = self::admin_url();
5759
			$bits      = wp_parse_url( $admin_url );
5760
5761
			if ( is_array( $bits ) ) {
5762
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5763
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5764
			} else {
5765
				$path = $domain = null;
5766
			}
5767
		}
5768
5769
		// Extract state from cookies and delete cookies
5770
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5771
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5772
			unset( $_COOKIE['jetpackState'] );
5773
			foreach ( $yum as $k => $v ) {
0 ignored issues
show
Bug introduced by
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...
5774
				if ( strlen( $v ) ) {
5775
					$state[ $k ] = $v;
5776
				}
5777
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5778
			}
5779
		}
5780
5781
		if ( $restate ) {
5782
			foreach ( $state as $k => $v ) {
5783
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5784
			}
5785
			return;
5786
		}
5787
5788
		// Get a state variable.
5789
		if ( isset( $key ) && ! isset( $value ) ) {
5790
			if ( array_key_exists( $key, $state ) ) {
5791
				return $state[ $key ];
5792
			}
5793
			return null;
5794
		}
5795
5796
		// Set a state variable.
5797
		if ( isset( $key ) && isset( $value ) ) {
5798
			if ( is_array( $value ) && isset( $value[0] ) ) {
5799
				$value = $value[0];
5800
			}
5801
			$state[ $key ] = $value;
5802
			if ( ! headers_sent() ) {
5803
				if ( self::should_set_cookie( $key ) ) {
5804
					setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5805
				}
5806
			}
5807
		}
5808
	}
5809
5810
	public static function restate() {
5811
		self::state( null, null, true );
5812
	}
5813
5814
	/**
5815
	 * Determines whether the jetpackState[$key] value should be added to the
5816
	 * cookie.
5817
	 *
5818
	 * @param string $key The state key.
5819
	 *
5820
	 * @return boolean Whether the value should be added to the cookie.
5821
	 */
5822
	public static function should_set_cookie( $key ) {
5823
		global $current_screen;
5824
		$page = isset( $current_screen->base ) ? $current_screen->base : null;
5825
5826
		if ( 'toplevel_page_jetpack' === $page && 'display_update_modal' === $key ) {
5827
			return false;
5828
		}
5829
5830
		return true;
5831
	}
5832
5833
	public static function check_privacy( $file ) {
5834
		static $is_site_publicly_accessible = null;
5835
5836
		if ( is_null( $is_site_publicly_accessible ) ) {
5837
			$is_site_publicly_accessible = false;
5838
5839
			$rpc = new Jetpack_IXR_Client();
5840
5841
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5842
			if ( $success ) {
5843
				$response = $rpc->getResponse();
5844
				if ( $response ) {
5845
					$is_site_publicly_accessible = true;
5846
				}
5847
			}
5848
5849
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5850
		}
5851
5852
		if ( $is_site_publicly_accessible ) {
5853
			return;
5854
		}
5855
5856
		$module_slug = self::get_module_slug( $file );
5857
5858
		$privacy_checks = self::state( 'privacy_checks' );
5859
		if ( ! $privacy_checks ) {
5860
			$privacy_checks = $module_slug;
5861
		} else {
5862
			$privacy_checks .= ",$module_slug";
5863
		}
5864
5865
		self::state( 'privacy_checks', $privacy_checks );
5866
	}
5867
5868
	/**
5869
	 * Helper method for multicall XMLRPC.
5870
	 *
5871
	 * @deprecated since 8.9.0
5872
	 * @see Automattic\\Jetpack\\Connection\\Xmlrpc_Async_Call::add_call()
5873
	 *
5874
	 * @param ...$args Args for the async_call.
5875
	 */
5876
	public static function xmlrpc_async_call( ...$args ) {
5877
5878
		_deprecated_function( 'Jetpack::xmlrpc_async_call', 'jetpack-8.9.0', 'Automattic\\Jetpack\\Connection\\Xmlrpc_Async_Call::add_call' );
5879
5880
		global $blog_id;
5881
		static $clients = array();
5882
5883
		$client_blog_id = is_multisite() ? $blog_id : 0;
5884
5885
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5886
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => true ) );
5887
			if ( function_exists( 'ignore_user_abort' ) ) {
5888
				ignore_user_abort( true );
5889
			}
5890
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5891
		}
5892
5893
		if ( ! empty( $args[0] ) ) {
5894
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5895
		} elseif ( is_multisite() ) {
5896
			foreach ( $clients as $client_blog_id => $client ) {
5897
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5898
					continue;
5899
				}
5900
5901
				$switch_success = switch_to_blog( $client_blog_id, true );
5902
				if ( ! $switch_success ) {
5903
					continue;
5904
				}
5905
5906
				flush();
5907
				$client->query();
5908
5909
				restore_current_blog();
5910
			}
5911
		} else {
5912
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5913
				flush();
5914
				$clients[0]->query();
5915
			}
5916
		}
5917
	}
5918
5919
	/**
5920
	 * Serve a WordPress.com static resource via a randomized wp.com subdomain.
5921
	 *
5922
	 * @deprecated 9.3.0 Use Assets::staticize_subdomain.
5923
	 *
5924
	 * @param string $url WordPress.com static resource URL.
5925
	 */
5926
	public static function staticize_subdomain( $url ) {
5927
		_deprecated_function( __METHOD__, 'jetpack-9.3.0', 'Automattic\Jetpack\Assets::staticize_subdomain' );
5928
		return Assets::staticize_subdomain( $url );
5929
	}
5930
5931
	/* JSON API Authorization */
5932
5933
	/**
5934
	 * Handles the login action for Authorizing the JSON API
5935
	 */
5936
	function login_form_json_api_authorization() {
5937
		$this->verify_json_api_authorization_request();
5938
5939
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5940
5941
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5942
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5943
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5944
	}
5945
5946
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5947
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5948
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5949
			return $url;
5950
		}
5951
5952
		$parsed_url = wp_parse_url( $url );
5953
		$url        = strtok( $url, '?' );
5954
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5955
		if ( ! empty( $parsed_url['query'] ) ) {
5956
			$url .= "&{$parsed_url['query']}";
5957
		}
5958
5959
		return $url;
5960
	}
5961
5962
	// Make sure the POSTed request is handled by the same action
5963
	function preserve_action_in_login_form_for_json_api_authorization() {
5964
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5965
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5966
	}
5967
5968
	// If someone logs in to approve API access, store the Access Code in usermeta
5969
	function store_json_api_authorization_token( $user_login, $user ) {
5970
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5971
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5972
		$token = wp_generate_password( 32, false );
5973
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5974
	}
5975
5976
	// Add public-api.wordpress.com to the safe redirect allowed list - only added when someone allows API access.
5977
	function allow_wpcom_public_api_domain( $domains ) {
5978
		$domains[] = 'public-api.wordpress.com';
5979
		return $domains;
5980
	}
5981
5982
	static function is_redirect_encoded( $redirect_url ) {
5983
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5984
	}
5985
5986
	// Add all wordpress.com environments to the safe redirect allowed list.
5987
	function allow_wpcom_environments( $domains ) {
5988
		$domains[] = 'wordpress.com';
5989
		$domains[] = 'wpcalypso.wordpress.com';
5990
		$domains[] = 'horizon.wordpress.com';
5991
		$domains[] = 'calypso.localhost';
5992
		return $domains;
5993
	}
5994
5995
	// Add the Access Code details to the public-api.wordpress.com redirect
5996
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5997
		return add_query_arg(
5998
			urlencode_deep(
5999
				array(
6000
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6001
					'jetpack-user-id' => (int) $user->ID,
6002
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6003
				)
6004
			),
6005
			$redirect_to
6006
		);
6007
	}
6008
6009
	/**
6010
	 * Verifies the request by checking the signature
6011
	 *
6012
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6013
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6014
	 *
6015
	 * @param null|array $environment
6016
	 */
6017
	function verify_json_api_authorization_request( $environment = null ) {
6018
		$environment = is_null( $environment )
6019
			? $_REQUEST
6020
			: $environment;
6021
6022
		//phpcs:ignore MediaWiki.Classes.UnusedUseStatement.UnusedUse,VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
6023
		list( $env_token, $env_version, $env_user_id ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $env_version 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...
6024
		$token = ( new Tokens() )->get_access_token( $env_user_id, $env_token );
6025
		if ( ! $token || empty( $token->secret ) ) {
6026
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
6027
		}
6028
6029
		$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' );
6030
6031
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
6032
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
6033
			/**
6034
			 * Jetpack authorisation request Error.
6035
			 *
6036
			 * @since 7.5.0
6037
			 */
6038
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
6039
			$die_error = sprintf(
6040
				/* translators: %s is a URL */
6041
				__( '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' ),
6042
				Redirect::get_url( 'jetpack-support-double-encoding' )
6043
			);
6044
		}
6045
6046
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6047
6048
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6049
			$signature = $jetpack_signature->sign_request(
6050
				$environment['token'],
6051
				$environment['timestamp'],
6052
				$environment['nonce'],
6053
				'',
6054
				'GET',
6055
				$environment['jetpack_json_api_original_query'],
6056
				null,
6057
				true
6058
			);
6059
		} else {
6060
			$signature = $jetpack_signature->sign_current_request(
6061
				array(
6062
					'body'   => null,
6063
					'method' => 'GET',
6064
				)
6065
			);
6066
		}
6067
6068
		if ( ! $signature ) {
6069
			wp_die( $die_error );
6070
		} elseif ( is_wp_error( $signature ) ) {
6071
			wp_die( $die_error );
6072
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
6073
			if ( is_ssl() ) {
6074
				// 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
6075
				$signature = $jetpack_signature->sign_current_request(
6076
					array(
6077
						'scheme' => 'http',
6078
						'body'   => null,
6079
						'method' => 'GET',
6080
					)
6081
				);
6082
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6083
					wp_die( $die_error );
6084
				}
6085
			} else {
6086
				wp_die( $die_error );
6087
			}
6088
		}
6089
6090
		$timestamp = (int) $environment['timestamp'];
6091
		$nonce     = stripslashes( (string) $environment['nonce'] );
6092
6093
		if ( ! $this->connection_manager ) {
6094
			$this->connection_manager = new Connection_Manager();
6095
		}
6096
6097
		if ( ! ( new Nonce_Handler() )->add( $timestamp, $nonce ) ) {
6098
			// De-nonce the nonce, at least for 5 minutes.
6099
			// 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)
6100
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6101
			if ( $old_nonce_time < time() - 300 ) {
6102
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6103
			}
6104
		}
6105
6106
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6107
		$data_filters = array(
6108
			'state'        => 'opaque',
6109
			'client_id'    => 'int',
6110
			'client_title' => 'string',
6111
			'client_image' => 'url',
6112
		);
6113
6114
		foreach ( $data_filters as $key => $sanitation ) {
6115
			if ( ! isset( $data->$key ) ) {
6116
				wp_die( $die_error );
6117
			}
6118
6119
			switch ( $sanitation ) {
6120
				case 'int':
6121
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6122
					break;
6123
				case 'opaque':
6124
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6125
					break;
6126
				case 'string':
6127
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6128
					break;
6129
				case 'url':
6130
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6131
					break;
6132
			}
6133
		}
6134
6135
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6136
			wp_die( $die_error );
6137
		}
6138
	}
6139
6140
	function login_message_json_api_authorization( $message ) {
6141
		return '<p class="message">' . sprintf(
6142
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6143
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6144
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6145
	}
6146
6147
	/**
6148
	 * Get $content_width, but with a <s>twist</s> filter.
6149
	 */
6150
	public static function get_content_width() {
6151
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6152
			? $GLOBALS['content_width']
6153
			: false;
6154
		/**
6155
		 * Filter the Content Width value.
6156
		 *
6157
		 * @since 2.2.3
6158
		 *
6159
		 * @param string $content_width Content Width value.
6160
		 */
6161
		return apply_filters( 'jetpack_content_width', $content_width );
6162
	}
6163
6164
	/**
6165
	 * Pings the WordPress.com Mirror Site for the specified options.
6166
	 *
6167
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6168
	 *
6169
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6170
	 */
6171
	public function get_cloud_site_options( $option_names ) {
6172
		$option_names = array_filter( (array) $option_names, 'is_string' );
6173
6174
		$xml = new Jetpack_IXR_Client();
6175
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6176
		if ( $xml->isError() ) {
6177
			return array(
6178
				'error_code' => $xml->getErrorCode(),
6179
				'error_msg'  => $xml->getErrorMessage(),
6180
			);
6181
		}
6182
		$cloud_site_options = $xml->getResponse();
6183
6184
		return $cloud_site_options;
6185
	}
6186
6187
	/**
6188
	 * Checks if the site is currently in an identity crisis.
6189
	 *
6190
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6191
	 */
6192
	public static function check_identity_crisis() {
6193
		if ( ! self::is_connection_ready() || ( new Status() )->is_offline_mode() || ! self::validate_sync_error_idc_option() ) {
6194
			return false;
6195
		}
6196
6197
		return Jetpack_Options::get_option( 'sync_error_idc' );
6198
	}
6199
6200
	/**
6201
	 * Checks whether the home and siteurl specifically are allowed.
6202
	 * Written so that we don't have re-check $key and $value params every time
6203
	 * we want to check if this site is allowed, for example in footer.php
6204
	 *
6205
	 * @since  3.8.0
6206
	 * @return bool True = already allowed False = not on the allowed list.
6207
	 */
6208
	public static function is_staging_site() {
6209
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6210
		return ( new Status() )->is_staging_site();
6211
	}
6212
6213
	/**
6214
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6215
	 *
6216
	 * @since 4.4.0
6217
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6218
	 *
6219
	 * @return bool
6220
	 */
6221
	public static function validate_sync_error_idc_option() {
6222
		$is_valid = false;
6223
6224
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6225
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6226
		if ( $sync_error && self::sync_idc_optin() ) {
6227
			$local_options = self::get_sync_error_idc_option();
6228
			// Ensure all values are set.
6229
			if ( isset( $sync_error['home'] ) && isset( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6230
6231
				// If the WP.com expected home and siteurl match local home and siteurl it is not valid IDC.
6232
				if (
6233
						isset( $sync_error['wpcom_home'] ) &&
6234
						isset( $sync_error['wpcom_siteurl'] ) &&
6235
						$sync_error['wpcom_home'] === $local_options['home'] &&
6236
						$sync_error['wpcom_siteurl'] === $local_options['siteurl']
6237
				) {
6238
					$is_valid = false;
6239
					// Enable migrate_for_idc so that sync actions are accepted.
6240
					Jetpack_Options::update_option( 'migrate_for_idc', true );
6241
				} elseif ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6242
					$is_valid = true;
6243
				}
6244
			}
6245
		}
6246
6247
		/**
6248
		 * Filters whether the sync_error_idc option is valid.
6249
		 *
6250
		 * @since 4.4.0
6251
		 *
6252
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6253
		 */
6254
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6255
6256
		if ( ! $is_valid && $sync_error ) {
6257
			// Since the option exists, and did not validate, delete it
6258
			Jetpack_Options::delete_option( 'sync_error_idc' );
6259
		}
6260
6261
		return $is_valid;
6262
	}
6263
6264
	/**
6265
	 * Normalizes a url by doing three things:
6266
	 *  - Strips protocol
6267
	 *  - Strips www
6268
	 *  - Adds a trailing slash
6269
	 *
6270
	 * @since 4.4.0
6271
	 * @param string $url
6272
	 * @return WP_Error|string
6273
	 */
6274
	public static function normalize_url_protocol_agnostic( $url ) {
6275
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6276
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $parsed_url of type string|false is loosely compared to false; this is ambiguous if the string can be empty. You might want to explicitly use === false 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...
6277
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'cannot_parse_url'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
6278
		}
6279
6280
		// Strip www and protocols
6281
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6282
		return $url;
6283
	}
6284
6285
	/**
6286
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6287
	 *
6288
	 * @since 4.4.0
6289
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6290
	 *
6291
	 * @param array $response
6292
	 * @return array Array of the local urls, wpcom urls, and error code
6293
	 */
6294
	public static function get_sync_error_idc_option( $response = array() ) {
6295
		// Since the local options will hit the database directly, store the values
6296
		// in a transient to allow for autoloading and caching on subsequent views.
6297
		$local_options = get_transient( 'jetpack_idc_local' );
6298
		if ( false === $local_options ) {
6299
			$local_options = array(
6300
				'home'    => Functions::home_url(),
6301
				'siteurl' => Functions::site_url(),
6302
			);
6303
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6304
		}
6305
6306
		$options = array_merge( $local_options, $response );
6307
6308
		$returned_values = array();
6309
		foreach ( $options as $key => $option ) {
6310
			if ( 'error_code' === $key ) {
6311
				$returned_values[ $key ] = $option;
6312
				continue;
6313
			}
6314
6315
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6316
				continue;
6317
			}
6318
6319
			$returned_values[ $key ] = $normalized_url;
6320
		}
6321
6322
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6323
6324
		return $returned_values;
6325
	}
6326
6327
	/**
6328
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6329
	 * If set to true, the site will be put into staging mode.
6330
	 *
6331
	 * @since 4.3.2
6332
	 * @return bool
6333
	 */
6334
	public static function sync_idc_optin() {
6335
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6336
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6337
		} else {
6338
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6339
		}
6340
6341
		/**
6342
		 * Allows sites to opt in for IDC mitigation which blocks the site from syncing to WordPress.com when the home
6343
		 * URL or site URL do not match what WordPress.com expects. The default value is either true, or the value of
6344
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6345
		 *
6346
		 * @since 4.3.2
6347
		 *
6348
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6349
		 */
6350
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6351
	}
6352
6353
	/**
6354
	 * Maybe Use a .min.css stylesheet, maybe not.
6355
	 *
6356
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6357
	 */
6358
	public static function maybe_min_asset( $url, $path, $plugin ) {
6359
		// Short out on things trying to find actual paths.
6360
		if ( ! $path || empty( $plugin ) ) {
6361
			return $url;
6362
		}
6363
6364
		$path = ltrim( $path, '/' );
6365
6366
		// Strip out the abspath.
6367
		$base = dirname( plugin_basename( $plugin ) );
6368
6369
		// Short out on non-Jetpack assets.
6370
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6371
			return $url;
6372
		}
6373
6374
		// File name parsing.
6375
		$file              = "{$base}/{$path}";
6376
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6377
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6378
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6379
		$extension         = array_shift( $file_name_parts_r );
6380
6381
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6382
			// Already pointing at the minified version.
6383
			if ( 'min' === $file_name_parts_r[0] ) {
6384
				return $url;
6385
			}
6386
6387
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6388
			if ( file_exists( $min_full_path ) ) {
6389
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6390
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6391
				if ( 'css' === $extension ) {
6392
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6393
					self::$min_assets[ $key ] = $path;
6394
				}
6395
			}
6396
		}
6397
6398
		return $url;
6399
	}
6400
6401
	/**
6402
	 * If the asset is minified, let's flag .min as the suffix.
6403
	 *
6404
	 * Attached to `style_loader_src` filter.
6405
	 *
6406
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
Bug introduced by
There is no parameter named $tag. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6407
	 * @param string $handle The registered handle of the script in question.
6408
	 * @param string $href The url of the asset in question.
0 ignored issues
show
Bug introduced by
There is no parameter named $href. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6409
	 */
6410
	public static function set_suffix_on_min( $src, $handle ) {
6411
		if ( false === strpos( $src, '.min.css' ) ) {
6412
			return $src;
6413
		}
6414
6415
		if ( ! empty( self::$min_assets ) ) {
6416
			foreach ( self::$min_assets as $file => $path ) {
6417
				if ( false !== strpos( $src, $file ) ) {
6418
					wp_style_add_data( $handle, 'suffix', '.min' );
6419
					return $src;
6420
				}
6421
			}
6422
		}
6423
6424
		return $src;
6425
	}
6426
6427
	/**
6428
	 * Maybe inlines a stylesheet.
6429
	 *
6430
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6431
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6432
	 *
6433
	 * Attached to `style_loader_tag` filter.
6434
	 *
6435
	 * @param string $tag The tag that would link to the external asset.
6436
	 * @param string $handle The registered handle of the script in question.
6437
	 *
6438
	 * @return string
6439
	 */
6440
	public static function maybe_inline_style( $tag, $handle ) {
6441
		global $wp_styles;
6442
		$item = $wp_styles->registered[ $handle ];
6443
6444
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6445
			return $tag;
6446
		}
6447
6448
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6449
			$href = $matches[1];
6450
			// Strip off query string
6451
			if ( $pos = strpos( $href, '?' ) ) {
6452
				$href = substr( $href, 0, $pos );
6453
			}
6454
			// Strip off fragment
6455
			if ( $pos = strpos( $href, '#' ) ) {
6456
				$href = substr( $href, 0, $pos );
6457
			}
6458
		} else {
6459
			return $tag;
6460
		}
6461
6462
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6463
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6464
			return $tag;
6465
		}
6466
6467
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6468
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6469
			// And this isn't the pass that actually deals with the RTL version...
6470
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6471
				// Short out, as the RTL version will deal with it in a moment.
6472
				return $tag;
6473
			}
6474
		}
6475
6476
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6477
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6478
		if ( $css ) {
6479
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6480
			if ( empty( $item->extra['after'] ) ) {
6481
				wp_add_inline_style( $handle, $css );
6482
			} else {
6483
				array_unshift( $item->extra['after'], $css );
6484
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6485
			}
6486
		}
6487
6488
		return $tag;
6489
	}
6490
6491
	/**
6492
	 * Loads a view file from the views
6493
	 *
6494
	 * Data passed in with the $data parameter will be available in the
6495
	 * template file as $data['value']
6496
	 *
6497
	 * @param string $template - Template file to load
6498
	 * @param array  $data - Any data to pass along to the template
6499
	 * @return boolean - If template file was found
6500
	 **/
6501
	public function load_view( $template, $data = array() ) {
6502
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6503
6504
		if ( file_exists( $views_dir . $template ) ) {
6505
			require_once $views_dir . $template;
6506
			return true;
6507
		}
6508
6509
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6510
		return false;
6511
	}
6512
6513
	/**
6514
	 * Throws warnings for deprecated hooks to be removed from Jetpack that cannot remain in the original place in the code.
6515
	 */
6516
	public function deprecated_hooks() {
6517
		$filter_deprecated_list = array(
6518
			'jetpack_bail_on_shortcode'                    => array(
6519
				'replacement' => 'jetpack_shortcodes_to_include',
6520
				'version'     => 'jetpack-3.1.0',
6521
			),
6522
			'wpl_sharing_2014_1'                           => array(
6523
				'replacement' => null,
6524
				'version'     => 'jetpack-3.6.0',
6525
			),
6526
			'jetpack-tools-to-include'                     => array(
6527
				'replacement' => 'jetpack_tools_to_include',
6528
				'version'     => 'jetpack-3.9.0',
6529
			),
6530
			'jetpack_identity_crisis_options_to_check'     => array(
6531
				'replacement' => null,
6532
				'version'     => 'jetpack-4.0.0',
6533
			),
6534
			'update_option_jetpack_single_user_site'       => array(
6535
				'replacement' => null,
6536
				'version'     => 'jetpack-4.3.0',
6537
			),
6538
			'audio_player_default_colors'                  => array(
6539
				'replacement' => null,
6540
				'version'     => 'jetpack-4.3.0',
6541
			),
6542
			'add_option_jetpack_featured_images_enabled'   => array(
6543
				'replacement' => null,
6544
				'version'     => 'jetpack-4.3.0',
6545
			),
6546
			'add_option_jetpack_update_details'            => array(
6547
				'replacement' => null,
6548
				'version'     => 'jetpack-4.3.0',
6549
			),
6550
			'add_option_jetpack_updates'                   => array(
6551
				'replacement' => null,
6552
				'version'     => 'jetpack-4.3.0',
6553
			),
6554
			'add_option_jetpack_network_name'              => array(
6555
				'replacement' => null,
6556
				'version'     => 'jetpack-4.3.0',
6557
			),
6558
			'add_option_jetpack_network_allow_new_registrations' => array(
6559
				'replacement' => null,
6560
				'version'     => 'jetpack-4.3.0',
6561
			),
6562
			'add_option_jetpack_network_add_new_users'     => array(
6563
				'replacement' => null,
6564
				'version'     => 'jetpack-4.3.0',
6565
			),
6566
			'add_option_jetpack_network_site_upload_space' => array(
6567
				'replacement' => null,
6568
				'version'     => 'jetpack-4.3.0',
6569
			),
6570
			'add_option_jetpack_network_upload_file_types' => array(
6571
				'replacement' => null,
6572
				'version'     => 'jetpack-4.3.0',
6573
			),
6574
			'add_option_jetpack_network_enable_administration_menus' => array(
6575
				'replacement' => null,
6576
				'version'     => 'jetpack-4.3.0',
6577
			),
6578
			'add_option_jetpack_is_multi_site'             => array(
6579
				'replacement' => null,
6580
				'version'     => 'jetpack-4.3.0',
6581
			),
6582
			'add_option_jetpack_is_main_network'           => array(
6583
				'replacement' => null,
6584
				'version'     => 'jetpack-4.3.0',
6585
			),
6586
			'add_option_jetpack_main_network_site'         => array(
6587
				'replacement' => null,
6588
				'version'     => 'jetpack-4.3.0',
6589
			),
6590
			'jetpack_sync_all_registered_options'          => array(
6591
				'replacement' => null,
6592
				'version'     => 'jetpack-4.3.0',
6593
			),
6594
			'jetpack_has_identity_crisis'                  => array(
6595
				'replacement' => 'jetpack_sync_error_idc_validation',
6596
				'version'     => 'jetpack-4.4.0',
6597
			),
6598
			'jetpack_is_post_mailable'                     => array(
6599
				'replacement' => null,
6600
				'version'     => 'jetpack-4.4.0',
6601
			),
6602
			'jetpack_seo_site_host'                        => array(
6603
				'replacement' => null,
6604
				'version'     => 'jetpack-5.1.0',
6605
			),
6606
			'jetpack_installed_plugin'                     => array(
6607
				'replacement' => 'jetpack_plugin_installed',
6608
				'version'     => 'jetpack-6.0.0',
6609
			),
6610
			'jetpack_holiday_snow_option_name'             => array(
6611
				'replacement' => null,
6612
				'version'     => 'jetpack-6.0.0',
6613
			),
6614
			'jetpack_holiday_chance_of_snow'               => array(
6615
				'replacement' => null,
6616
				'version'     => 'jetpack-6.0.0',
6617
			),
6618
			'jetpack_holiday_snow_js_url'                  => array(
6619
				'replacement' => null,
6620
				'version'     => 'jetpack-6.0.0',
6621
			),
6622
			'jetpack_is_holiday_snow_season'               => array(
6623
				'replacement' => null,
6624
				'version'     => 'jetpack-6.0.0',
6625
			),
6626
			'jetpack_holiday_snow_option_updated'          => array(
6627
				'replacement' => null,
6628
				'version'     => 'jetpack-6.0.0',
6629
			),
6630
			'jetpack_holiday_snowing'                      => array(
6631
				'replacement' => null,
6632
				'version'     => 'jetpack-6.0.0',
6633
			),
6634
			'jetpack_sso_auth_cookie_expirtation'          => array(
6635
				'replacement' => 'jetpack_sso_auth_cookie_expiration',
6636
				'version'     => 'jetpack-6.1.0',
6637
			),
6638
			'jetpack_cache_plans'                          => array(
6639
				'replacement' => null,
6640
				'version'     => 'jetpack-6.1.0',
6641
			),
6642
6643
			'jetpack_lazy_images_skip_image_with_atttributes' => array(
6644
				'replacement' => 'jetpack_lazy_images_skip_image_with_attributes',
6645
				'version'     => 'jetpack-6.5.0',
6646
			),
6647
			'jetpack_enable_site_verification'             => array(
6648
				'replacement' => null,
6649
				'version'     => 'jetpack-6.5.0',
6650
			),
6651
			'can_display_jetpack_manage_notice'            => array(
6652
				'replacement' => null,
6653
				'version'     => 'jetpack-7.3.0',
6654
			),
6655
			'atd_http_post_timeout'                        => array(
6656
				'replacement' => null,
6657
				'version'     => 'jetpack-7.3.0',
6658
			),
6659
			'atd_service_domain'                           => array(
6660
				'replacement' => null,
6661
				'version'     => 'jetpack-7.3.0',
6662
			),
6663
			'atd_load_scripts'                             => array(
6664
				'replacement' => null,
6665
				'version'     => 'jetpack-7.3.0',
6666
			),
6667
			'jetpack_widget_authors_exclude'               => array(
6668
				'replacement' => 'jetpack_widget_authors_params',
6669
				'version'     => 'jetpack-7.7.0',
6670
			),
6671
			// Removed in Jetpack 7.9.0
6672
			'jetpack_pwa_manifest'                         => array(
6673
				'replacement' => null,
6674
				'version'     => 'jetpack-7.9.0',
6675
			),
6676
			'jetpack_pwa_background_color'                 => array(
6677
				'replacement' => null,
6678
				'version'     => 'jetpack-7.9.0',
6679
			),
6680
			'jetpack_check_mobile'                         => array(
6681
				'replacement' => null,
6682
				'version'     => 'jetpack-8.3.0',
6683
			),
6684
			'jetpack_mobile_stylesheet'                    => array(
6685
				'replacement' => null,
6686
				'version'     => 'jetpack-8.3.0',
6687
			),
6688
			'jetpack_mobile_template'                      => array(
6689
				'replacement' => null,
6690
				'version'     => 'jetpack-8.3.0',
6691
			),
6692
			'jetpack_mobile_theme_menu'                    => array(
6693
				'replacement' => null,
6694
				'version'     => 'jetpack-8.3.0',
6695
			),
6696
			'minileven_show_featured_images'               => array(
6697
				'replacement' => null,
6698
				'version'     => 'jetpack-8.3.0',
6699
			),
6700
			'minileven_attachment_size'                    => array(
6701
				'replacement' => null,
6702
				'version'     => 'jetpack-8.3.0',
6703
			),
6704
			'instagram_cache_oembed_api_response_body'     => array(
6705
				'replacement' => null,
6706
				'version'     => 'jetpack-9.1.0',
6707
			),
6708
			'jetpack_can_make_outbound_https'              => array(
6709
				'replacement' => null,
6710
				'version'     => 'jetpack-9.1.0',
6711
			),
6712
		);
6713
6714
		foreach ( $filter_deprecated_list as $tag => $args ) {
6715
			if ( has_filter( $tag ) ) {
6716
				apply_filters_deprecated( $tag, array( null ), $args['version'], $args['replacement'] );
6717
			}
6718
		}
6719
6720
		$action_deprecated_list = array(
6721
			'jetpack_updated_theme'        => array(
6722
				'replacement' => 'jetpack_updated_themes',
6723
				'version'     => 'jetpack-6.2.0',
6724
			),
6725
			'atd_http_post_error'          => array(
6726
				'replacement' => null,
6727
				'version'     => 'jetpack-7.3.0',
6728
			),
6729
			'mobile_reject_mobile'         => array(
6730
				'replacement' => null,
6731
				'version'     => 'jetpack-8.3.0',
6732
			),
6733
			'mobile_force_mobile'          => array(
6734
				'replacement' => null,
6735
				'version'     => 'jetpack-8.3.0',
6736
			),
6737
			'mobile_app_promo_download'    => array(
6738
				'replacement' => null,
6739
				'version'     => 'jetpack-8.3.0',
6740
			),
6741
			'mobile_setup'                 => array(
6742
				'replacement' => null,
6743
				'version'     => 'jetpack-8.3.0',
6744
			),
6745
			'jetpack_mobile_footer_before' => array(
6746
				'replacement' => null,
6747
				'version'     => 'jetpack-8.3.0',
6748
			),
6749
			'wp_mobile_theme_footer'       => array(
6750
				'replacement' => null,
6751
				'version'     => 'jetpack-8.3.0',
6752
			),
6753
			'minileven_credits'            => array(
6754
				'replacement' => null,
6755
				'version'     => 'jetpack-8.3.0',
6756
			),
6757
			'jetpack_mobile_header_before' => array(
6758
				'replacement' => null,
6759
				'version'     => 'jetpack-8.3.0',
6760
			),
6761
			'jetpack_mobile_header_after'  => array(
6762
				'replacement' => null,
6763
				'version'     => 'jetpack-8.3.0',
6764
			),
6765
		);
6766
6767
		foreach ( $action_deprecated_list as $tag => $args ) {
6768
			if ( has_action( $tag ) ) {
6769
				do_action_deprecated( $tag, array(), $args['version'], $args['replacement'] );
6770
			}
6771
		}
6772
	}
6773
6774
	/**
6775
	 * Converts any url in a stylesheet, to the correct absolute url.
6776
	 *
6777
	 * Considerations:
6778
	 *  - Normal, relative URLs     `feh.png`
6779
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6780
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6781
	 *  - Absolute URLs             `http://domain.com/feh.png`
6782
	 *  - Domain root relative URLs `/feh.png`
6783
	 *
6784
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6785
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6786
	 *
6787
	 * @return mixed|string
6788
	 */
6789
	public static function absolutize_css_urls( $css, $css_file_url ) {
6790
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6791
		$css_dir = dirname( $css_file_url );
6792
		$p       = wp_parse_url( $css_dir );
6793
		$domain  = sprintf(
6794
			'%1$s//%2$s%3$s%4$s',
6795
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6796
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6797
			$p['host'],
6798
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6799
		);
6800
6801
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6802
			$find = $replace = array();
6803
			foreach ( $matches as $match ) {
6804
				$url = trim( $match['path'], "'\" \t" );
6805
6806
				// If this is a data url, we don't want to mess with it.
6807
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6808
					continue;
6809
				}
6810
6811
				// If this is an absolute or protocol-agnostic url,
6812
				// we don't want to mess with it.
6813
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6814
					continue;
6815
				}
6816
6817
				switch ( substr( $url, 0, 1 ) ) {
6818
					case '/':
6819
						$absolute = $domain . $url;
6820
						break;
6821
					default:
6822
						$absolute = $css_dir . '/' . $url;
6823
				}
6824
6825
				$find[]    = $match[0];
6826
				$replace[] = sprintf( 'url("%s")', $absolute );
6827
			}
6828
			$css = str_replace( $find, $replace, $css );
6829
		}
6830
6831
		return $css;
6832
	}
6833
6834
	/**
6835
	 * This methods removes all of the registered css files on the front end
6836
	 * from Jetpack in favor of using a single file. In effect "imploding"
6837
	 * all the files into one file.
6838
	 *
6839
	 * Pros:
6840
	 * - Uses only ONE css asset connection instead of 15
6841
	 * - Saves a minimum of 56k
6842
	 * - Reduces server load
6843
	 * - Reduces time to first painted byte
6844
	 *
6845
	 * Cons:
6846
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6847
	 *      should not cause any issues with themes.
6848
	 * - Plugins/themes dequeuing styles no longer do anything. See
6849
	 *      jetpack_implode_frontend_css filter for a workaround
6850
	 *
6851
	 * For some situations developers may wish to disable css imploding and
6852
	 * instead operate in legacy mode where each file loads seperately and
6853
	 * can be edited individually or dequeued. This can be accomplished with
6854
	 * the following line:
6855
	 *
6856
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6857
	 *
6858
	 * @since 3.2
6859
	 **/
6860
	public function implode_frontend_css( $travis_test = false ) {
6861
		$do_implode = true;
6862
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6863
			$do_implode = false;
6864
		}
6865
6866
		// Do not implode CSS when the page loads via the AMP plugin.
6867
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6868
			$do_implode = false;
6869
		}
6870
6871
		/**
6872
		 * Allow CSS to be concatenated into a single jetpack.css file.
6873
		 *
6874
		 * @since 3.2.0
6875
		 *
6876
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6877
		 */
6878
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6879
6880
		// Do not use the imploded file when default behavior was altered through the filter
6881
		if ( ! $do_implode ) {
6882
			return;
6883
		}
6884
6885
		// We do not want to use the imploded file in dev mode, or if not connected
6886
		if ( ( new Status() )->is_offline_mode() || ! self::is_connection_ready() ) {
6887
			if ( ! $travis_test ) {
6888
				return;
6889
			}
6890
		}
6891
6892
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6893
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6894
			return;
6895
		}
6896
6897
		/*
6898
		 * Now we assume Jetpack is connected and able to serve the single
6899
		 * file.
6900
		 *
6901
		 * In the future there will be a check here to serve the file locally
6902
		 * or potentially from the Jetpack CDN
6903
		 *
6904
		 * For now:
6905
		 * - Enqueue a single imploded css file
6906
		 * - Zero out the style_loader_tag for the bundled ones
6907
		 * - Be happy, drink scotch
6908
		 */
6909
6910
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6911
6912
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6913
6914
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6915
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6916
	}
6917
6918
	function concat_remove_style_loader_tag( $tag, $handle ) {
6919
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6920
			$tag = '';
6921
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6922
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6923
			}
6924
		}
6925
6926
		return $tag;
6927
	}
6928
6929
	/**
6930
	 * @deprecated
6931
	 * @see Automattic\Jetpack\Assets\add_aync_script
6932
	 */
6933
	public function script_add_async( $tag, $handle, $src ) {
6934
		_deprecated_function( __METHOD__, 'jetpack-8.6.0' );
6935
	}
6936
6937
	/*
6938
	 * Check the heartbeat data
6939
	 *
6940
	 * Organizes the heartbeat data by severity.  For example, if the site
6941
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6942
	 *
6943
	 * Data will be added to "caution" array, if it either:
6944
	 *  - Out of date Jetpack version
6945
	 *  - Out of date WP version
6946
	 *  - Out of date PHP version
6947
	 *
6948
	 * $return array $filtered_data
6949
	 */
6950
	public static function jetpack_check_heartbeat_data() {
6951
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6952
6953
		$good    = array();
6954
		$caution = array();
6955
		$bad     = array();
6956
6957
		foreach ( $raw_data as $stat => $value ) {
6958
6959
			// Check jetpack version
6960
			if ( 'version' == $stat ) {
6961
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6962
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6963
					continue;
6964
				}
6965
			}
6966
6967
			// Check WP version
6968
			if ( 'wp-version' == $stat ) {
6969
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6970
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6971
					continue;
6972
				}
6973
			}
6974
6975
			// Check PHP version
6976
			if ( 'php-version' == $stat ) {
6977
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6978
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_PHP_VERSION;
6979
					continue;
6980
				}
6981
			}
6982
6983
			// Check ID crisis
6984
			if ( 'identitycrisis' == $stat ) {
6985
				if ( 'yes' == $value ) {
6986
					$bad[ $stat ] = $value;
6987
					continue;
6988
				}
6989
			}
6990
6991
			// The rest are good :)
6992
			$good[ $stat ] = $value;
6993
		}
6994
6995
		$filtered_data = array(
6996
			'good'    => $good,
6997
			'caution' => $caution,
6998
			'bad'     => $bad,
6999
		);
7000
7001
		return $filtered_data;
7002
	}
7003
7004
	/*
7005
	 * This method is used to organize all options that can be reset
7006
	 * without disconnecting Jetpack.
7007
	 *
7008
	 * It is used in class.jetpack-cli.php to reset options
7009
	 *
7010
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
7011
	 *
7012
	 * @return array of options to delete.
7013
	 */
7014
	public static function get_jetpack_options_for_reset() {
7015
		return Jetpack_Options::get_options_for_reset();
7016
	}
7017
7018
	/*
7019
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
7020
	 * so we can bring them directly to their site in calypso.
7021
	 *
7022
	 * @deprecated 9.2.0 Use Automattic\Jetpack\Status::get_site_suffix
7023
	 *
7024
	 * @param string | url
7025
	 * @return string | url without the guff
7026
	 */
7027
	public static function build_raw_urls( $url ) {
7028
		_deprecated_function( __METHOD__, 'jetpack-9.2.0', 'Automattic\Jetpack\Status::get_site_suffix' );
7029
7030
		return ( new Status() )->get_site_suffix( $url );
7031
	}
7032
7033
	/**
7034
	 * Stores and prints out domains to prefetch for page speed optimization.
7035
	 *
7036
	 * @deprecated 8.8.0 Use Jetpack::add_resource_hints.
7037
	 *
7038
	 * @param string|array $urls URLs to hint.
0 ignored issues
show
Documentation introduced by
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...
7039
	 */
7040
	public static function dns_prefetch( $urls = null ) {
7041
		_deprecated_function( __FUNCTION__, 'jetpack-8.8.0', 'Automattic\Jetpack\Assets::add_resource_hint' );
7042
		if ( $urls ) {
7043
			Assets::add_resource_hint( $urls );
7044
		}
7045
	}
7046
7047
	public function wp_dashboard_setup() {
7048
		if ( self::is_connection_ready() ) {
7049
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
7050
		}
7051
7052
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
7053
			$jetpack_logo = new Jetpack_Logo();
7054
			$widget_title = sprintf(
7055
				/* translators: Placeholder is a Jetpack logo. */
7056
				__( 'Stats by %s', 'jetpack' ),
7057
				$jetpack_logo->get_jp_emblem( true )
7058
			);
7059
7060
			// Wrap title in span so Logo can be properly styled.
7061
			$widget_title = sprintf(
7062
				'<span>%s</span>',
7063
				$widget_title
7064
			);
7065
7066
			wp_add_dashboard_widget(
7067
				'jetpack_summary_widget',
7068
				$widget_title,
7069
				array( __CLASS__, 'dashboard_widget' )
7070
			);
7071
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
7072
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
7073
7074
			// If we're inactive and not in offline mode, sort our box to the top.
7075
			if ( ! self::is_connection_ready() && ! ( new Status() )->is_offline_mode() ) {
7076
				global $wp_meta_boxes;
7077
7078
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
7079
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
7080
7081
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
7082
			}
7083
		}
7084
	}
7085
7086
	/**
7087
	 * @param mixed $result Value for the user's option
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
7088
	 * @return mixed
7089
	 */
7090
	function get_user_option_meta_box_order_dashboard( $sorted ) {
7091
		if ( ! is_array( $sorted ) ) {
7092
			return $sorted;
7093
		}
7094
7095
		foreach ( $sorted as $box_context => $ids ) {
7096
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
7097
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
7098
				continue;
7099
			}
7100
7101
			$ids_array = explode( ',', $ids );
7102
			$key       = array_search( 'dashboard_stats', $ids_array );
7103
7104
			if ( false !== $key ) {
7105
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7106
				$ids_array[ $key ]      = 'jetpack_summary_widget';
7107
				$sorted[ $box_context ] = implode( ',', $ids_array );
7108
				// We've found it, stop searching, and just return.
7109
				break;
7110
			}
7111
		}
7112
7113
		return $sorted;
7114
	}
7115
7116
	public static function dashboard_widget() {
7117
		/**
7118
		 * Fires when the dashboard is loaded.
7119
		 *
7120
		 * @since 3.4.0
7121
		 */
7122
		do_action( 'jetpack_dashboard_widget' );
7123
	}
7124
7125
	public static function dashboard_widget_footer() {
7126
		?>
7127
		<footer>
7128
7129
		<div class="protect">
7130
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
7131
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
7132
				<p class="blocked-count">
7133
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
7134
				</p>
7135
				<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>
7136
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_offline_mode() ) : ?>
7137
				<a href="
7138
				<?php
7139
				echo esc_url(
7140
					wp_nonce_url(
7141
						self::admin_url(
7142
							array(
7143
								'action' => 'activate',
7144
								'module' => 'protect',
7145
							)
7146
						),
7147
						'jetpack_activate-protect'
7148
					)
7149
				);
7150
				?>
7151
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
7152
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
7153
				</a>
7154
			<?php else : ?>
7155
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
7156
			<?php endif; ?>
7157
		</div>
7158
7159
		<div class="akismet">
7160
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
7161
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7162
				<p class="blocked-count">
7163
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
7164
				</p>
7165
				<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>
7166
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7167
				<a href="
7168
				<?php
7169
				echo esc_url(
7170
					wp_nonce_url(
7171
						add_query_arg(
7172
							array(
7173
								'action' => 'activate',
7174
								'plugin' => 'akismet/akismet.php',
7175
							),
7176
							admin_url( 'plugins.php' )
7177
						),
7178
						'activate-plugin_akismet/akismet.php'
7179
					)
7180
				);
7181
				?>
7182
							" class="button button-jetpack">
7183
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
7184
				</a>
7185
			<?php else : ?>
7186
				<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>
7187
			<?php endif; ?>
7188
		</div>
7189
7190
		</footer>
7191
		<?php
7192
	}
7193
7194
	/*
7195
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7196
	 */
7197
	function jetpack_icon_user_connected( $columns ) {
7198
		$columns['user_jetpack'] = '';
7199
		return $columns;
7200
	}
7201
7202
	/*
7203
	 * Show Jetpack icon if the user is linked.
7204
	 */
7205
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7206
		if ( 'user_jetpack' === $col && self::connection()->is_user_connected( $user_id ) ) {
7207
			$jetpack_logo = new Jetpack_Logo();
7208
			$emblem_html  = sprintf(
7209
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7210
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7211
				$jetpack_logo->get_jp_emblem()
7212
			);
7213
			return $emblem_html;
7214
		}
7215
7216
		return $val;
7217
	}
7218
7219
	/*
7220
	 * Style the Jetpack user column
7221
	 */
7222
	function jetpack_user_col_style() {
7223
		global $current_screen;
7224
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7225
			?>
7226
			<style>
7227
				.fixed .column-user_jetpack {
7228
					width: 21px;
7229
				}
7230
				.jp-emblem-user-admin svg {
7231
					width: 20px;
7232
					height: 20px;
7233
				}
7234
				.jp-emblem-user-admin path {
7235
					fill: #00BE28;
7236
				}
7237
			</style>
7238
			<?php
7239
		}
7240
	}
7241
7242
	/**
7243
	 * Checks if Akismet is active and working.
7244
	 *
7245
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7246
	 * that implied usage of methods present since more recent version.
7247
	 * See https://github.com/Automattic/jetpack/pull/9585
7248
	 *
7249
	 * @since  5.1.0
7250
	 *
7251
	 * @return bool True = Akismet available. False = Aksimet not available.
7252
	 */
7253
	public static function is_akismet_active() {
7254
		static $status = null;
7255
7256
		if ( ! is_null( $status ) ) {
7257
			return $status;
7258
		}
7259
7260
		// Check if a modern version of Akismet is active.
7261
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7262
			$status = false;
7263
			return $status;
7264
		}
7265
7266
		// Make sure there is a key known to Akismet at all before verifying key.
7267
		$akismet_key = Akismet::get_api_key();
7268
		if ( ! $akismet_key ) {
7269
			$status = false;
7270
			return $status;
7271
		}
7272
7273
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7274
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7275
7276
		// 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.
7277
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7278
		// We cache the result of the Akismet key verification for ten minutes.
7279
		if ( ! $akismet_key_state || $recheck ) {
7280
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7281
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7282
		}
7283
7284
		$status = 'valid' === $akismet_key_state;
7285
7286
		return $status;
7287
	}
7288
7289
	/**
7290
	 * @deprecated
7291
	 *
7292
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7293
	 */
7294
	public static function is_function_in_backtrace() {
7295
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7296
	}
7297
7298
	/**
7299
	 * Given a minified path, and a non-minified path, will return
7300
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7301
	 *
7302
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7303
	 * root Jetpack directory.
7304
	 *
7305
	 * @since 5.6.0
7306
	 *
7307
	 * @param string $min_path
7308
	 * @param string $non_min_path
7309
	 * @return string The URL to the file
7310
	 */
7311
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7312
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7313
	}
7314
7315
	/**
7316
	 * Checks for whether Jetpack Backup is enabled.
7317
	 * Will return true if the state of Backup is anything except "unavailable".
7318
	 *
7319
	 * @return bool|int|mixed
7320
	 */
7321
	public static function is_rewind_enabled() {
7322
		// Rewind is a paid feature, therefore requires a user-level connection.
7323
		if ( ! static::connection()->has_connected_owner() ) {
7324
			return false;
7325
		}
7326
7327
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7328
		if ( false === $rewind_enabled ) {
7329
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7330
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7331
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7332
				&& ! empty( $rewind_data['state'] )
7333
				&& 'active' === $rewind_data['state'] )
7334
				? 1
7335
				: 0;
7336
7337
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7338
		}
7339
		return $rewind_enabled;
7340
	}
7341
7342
	/**
7343
	 * Return Calypso environment value; used for developing Jetpack and pairing
7344
	 * it with different Calypso enrionments, such as localhost.
7345
	 *
7346
	 * @since 7.4.0
7347
	 *
7348
	 * @return string Calypso environment
7349
	 */
7350
	public static function get_calypso_env() {
7351
		if ( isset( $_GET['calypso_env'] ) ) {
7352
			return sanitize_key( $_GET['calypso_env'] );
7353
		}
7354
7355
		if ( getenv( 'CALYPSO_ENV' ) ) {
7356
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7357
		}
7358
7359
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7360
			return sanitize_key( CALYPSO_ENV );
7361
		}
7362
7363
		return '';
7364
	}
7365
7366
	/**
7367
	 * Returns the hostname with protocol for Calypso.
7368
	 * Used for developing Jetpack with Calypso.
7369
	 *
7370
	 * @since 8.4.0
7371
	 *
7372
	 * @return string Calypso host.
7373
	 */
7374
	public static function get_calypso_host() {
7375
		$calypso_env = self::get_calypso_env();
7376
		switch ( $calypso_env ) {
7377
			case 'development':
7378
				return 'http://calypso.localhost:3000/';
7379
			case 'wpcalypso':
7380
				return 'https://wpcalypso.wordpress.com/';
7381
			case 'horizon':
7382
				return 'https://horizon.wordpress.com/';
7383
			default:
7384
				return 'https://wordpress.com/';
7385
		}
7386
	}
7387
7388
	/**
7389
	 * Handles activating default modules as well general cleanup for the new connection.
7390
	 *
7391
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7392
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7393
	 * @param boolean $send_state_messages          Whether to send state messages.
7394
	 * @return void
7395
	 */
7396
	public static function handle_post_authorization_actions(
7397
		$activate_sso = false,
7398
		$redirect_on_activation_error = false,
7399
		$send_state_messages = true
7400
	) {
7401
		$other_modules = $activate_sso
7402
			? array( 'sso' )
7403
			: array();
7404
7405
		if ( Jetpack_Options::get_option( 'active_modules_initialized' ) ) {
7406
			$active_modules = Jetpack_Options::get_option( 'active_modules' );
7407
			self::delete_active_modules();
7408
7409
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
Documentation introduced by
999 is of type integer, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
7410
		} else {
7411
			// Default modules that don't require a user were already activated on site_register.
7412
			// This time let's activate only those that require a user, this assures we don't reactivate manually deactivated modules while the site was user-less.
7413
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages, null, true );
7414
			Jetpack_Options::update_option( 'active_modules_initialized', true );
7415
		}
7416
7417
		// Since this is a fresh connection, be sure to clear out IDC options
7418
		Jetpack_IDC::clear_all_idc_options();
7419
7420
		if ( $send_state_messages ) {
7421
			self::state( 'message', 'authorized' );
7422
		}
7423
	}
7424
7425
	/**
7426
	 * Returns a boolean for whether backups UI should be displayed or not.
7427
	 *
7428
	 * @return bool Should backups UI be displayed?
7429
	 */
7430
	public static function show_backups_ui() {
7431
		/**
7432
		 * Whether UI for backups should be displayed.
7433
		 *
7434
		 * @since 6.5.0
7435
		 *
7436
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7437
		 */
7438
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7439
	}
7440
7441
	/*
7442
	 * Deprecated manage functions
7443
	 */
7444
	function prepare_manage_jetpack_notice() {
7445
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7446
	}
7447
	function manage_activate_screen() {
7448
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7449
	}
7450
	function admin_jetpack_manage_notice() {
7451
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7452
	}
7453
	function opt_out_jetpack_manage_url() {
7454
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7455
	}
7456
	function opt_in_jetpack_manage_url() {
7457
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7458
	}
7459
	function opt_in_jetpack_manage_notice() {
7460
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7461
	}
7462
	function can_display_jetpack_manage_notice() {
7463
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7464
	}
7465
7466
	/**
7467
	 * Clean leftoveruser meta.
7468
	 *
7469
	 * Delete Jetpack-related user meta when it is no longer needed.
7470
	 *
7471
	 * @since 7.3.0
7472
	 *
7473
	 * @param int $user_id User ID being updated.
7474
	 */
7475
	public static function user_meta_cleanup( $user_id ) {
7476
		$meta_keys = array(
7477
			// AtD removed from Jetpack 7.3
7478
			'AtD_options',
7479
			'AtD_check_when',
7480
			'AtD_guess_lang',
7481
			'AtD_ignored_phrases',
7482
		);
7483
7484
		foreach ( $meta_keys as $meta_key ) {
7485
			if ( get_user_meta( $user_id, $meta_key ) ) {
7486
				delete_user_meta( $user_id, $meta_key );
7487
			}
7488
		}
7489
	}
7490
7491
	/**
7492
	 * Checks if a Jetpack site is both active and not in offline mode.
7493
	 *
7494
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_offline_mode`.
7495
	 *
7496
	 * @deprecated 8.8.0
7497
	 *
7498
	 * @return bool True if Jetpack is active and not in offline mode.
7499
	 */
7500
	public static function is_active_and_not_development_mode() {
7501
		_deprecated_function( __FUNCTION__, 'jetpack-8.8.0', 'Jetpack::is_active_and_not_offline_mode' );
7502
		if ( ! self::is_active() || ( new Status() )->is_offline_mode() ) {
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack::is_active() has been deprecated with message: 9.6.0

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...
7503
			return false;
7504
		}
7505
		return true;
7506
	}
7507
7508
	/**
7509
	 * Checks if a Jetpack site is both active and not in offline mode.
7510
	 *
7511
	 * This is a DRY function to avoid repeating `Jetpack::is_connection_ready && ! Automattic\Jetpack\Status->is_offline_mode`.
7512
	 *
7513
	 * @since 8.8.0
7514
	 *
7515
	 * @return bool True if Jetpack is active and not in offline mode.
7516
	 */
7517
	public static function is_active_and_not_offline_mode() {
7518
		if ( ! self::is_connection_ready() || ( new Status() )->is_offline_mode() ) {
7519
			return false;
7520
		}
7521
		return true;
7522
	}
7523
7524
	/**
7525
	 * Returns the list of products that we have available for purchase.
7526
	 */
7527
	public static function get_products_for_purchase() {
7528
		$products = array();
7529
		if ( ! is_multisite() ) {
7530
			$products[] = array(
7531
				'key'               => 'backup',
7532
				'title'             => __( 'Jetpack Backup', 'jetpack' ),
7533
				'short_description' => __( 'Always-on backups ensure you never lose your site.', 'jetpack' ),
7534
				'learn_more'        => __( 'Which backup option is best for me?', 'jetpack' ),
7535
				'description'       => __( 'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.', 'jetpack' ),
7536
				'options_label'     => __( 'Select a backup option:', 'jetpack' ),
7537
				'options'           => array(
7538
					array(
7539
						'type'        => 'daily',
7540
						'slug'        => 'jetpack-backup-daily',
7541
						'key'         => 'jetpack_backup_daily',
7542
						'name'        => __( 'Daily Backups', 'jetpack' ),
7543
						'description' => __( 'Your data is being securely backed up daily.', 'jetpack' ),
7544
					),
7545
					array(
7546
						'type'        => 'realtime',
7547
						'slug'        => 'jetpack-backup-realtime',
7548
						'key'         => 'jetpack_backup_realtime',
7549
						'name'        => __( 'Real-Time Backups', 'jetpack' ),
7550
						'description' => __( 'Your data is being securely backed up as you edit.', 'jetpack' ),
7551
					),
7552
				),
7553
				'default_option'    => 'realtime',
7554
				'show_promotion'    => true,
7555
				'discount_percent'  => 70,
7556
				'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'daily-backup-plan', 'realtime-backup-plan' ),
7557
			);
7558
7559
			$products[] = array(
7560
				'key'               => 'scan',
7561
				'title'             => __( 'Jetpack Scan', 'jetpack' ),
7562
				'short_description' => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7563
				'learn_more'        => __( 'Learn More', 'jetpack' ),
7564
				'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7565
				'show_promotion'    => true,
7566
				'discount_percent'  => 30,
7567
				'options'           => array(
7568
					array(
7569
						'type' => 'scan',
7570
						'slug' => 'jetpack-scan',
7571
						'key'  => 'jetpack_scan',
7572
						'name' => __( 'Daily Scan', 'jetpack' ),
7573
					),
7574
				),
7575
				'default_option'    => 'scan',
7576
				'included_in_plans' => array( 'premium-plan', 'business-plan', 'scan-plan' ),
7577
			);
7578
		}
7579
7580
		$products[] = array(
7581
			'key'               => 'search',
7582
			'title'             => __( 'Jetpack Search', 'jetpack' ),
7583
			'short_description' => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7584
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7585
			'description'       => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7586
			'label_popup'       => __( 'Records are all posts, pages, custom post types, and other types of content indexed by Jetpack Search.', 'jetpack' ),
7587
			'options'           => array(
7588
				array(
7589
					'type' => 'search',
7590
					'slug' => 'jetpack-search',
7591
					'key'  => 'jetpack_search',
7592
					'name' => __( 'Search', 'jetpack' ),
7593
				),
7594
			),
7595
			'tears'             => array(),
7596
			'default_option'    => 'search',
7597
			'show_promotion'    => false,
7598
			'included_in_plans' => array( 'search-plan' ),
7599
		);
7600
7601
		$products[] = array(
7602
			'key'               => 'anti-spam',
7603
			'title'             => __( 'Jetpack Anti-Spam', 'jetpack' ),
7604
			'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' ),
7605
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7606
			'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' ),
7607
			'options'           => array(
7608
				array(
7609
					'type' => 'anti-spam',
7610
					'slug' => 'jetpack-anti-spam',
7611
					'key'  => 'jetpack_anti_spam',
7612
					'name' => __( 'Anti-Spam', 'jetpack' ),
7613
				),
7614
			),
7615
			'default_option'    => 'anti-spam',
7616
			'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'anti-spam-plan' ),
7617
		);
7618
7619
		return $products;
7620
	}
7621
}
7622